@squidcloud/backend
    Preparing search index...

    Class SquidProject

    The SquidProject class is the entry point for the Squid backend project.

    Index

    Accessors

    squid

    Constructors

    constructor

    Methods

    cleanup metadata onIntegrationChanged onIntegrationCreated onIntegrationDeleted

    Accessors

    • get squid(): Squid

      Returns the main Squid instance with the current backend configuration.

      Returns Squid

    Constructors

    • Initializes lifecycle metadata so the runtime knows which hooks the connector implements.

      Returns SquidProject

    Methods

    • Invoked by the runtime when terminating the worker to release Squid client instances. Keep this method: tenant worker looks up default.cleanup directly. @internal.

      Returns Promise<void>

    • Exposes bundle metadata to the runtime. @internal.

      Returns ApplicationBundleData

    • Triggered whenever properties of an existing integration with a supported type are changed. @internal.

      Parameters

      • _context: OnIntegrationLifecycleInput

      Returns Promise<void>

    • Triggered when an integration of a supported type is created. @internal.

      Parameters

      • _context: OnIntegrationLifecycleInput

      Returns Promise<void>

    • Triggered when an existing integration with a supported type is being deleted, right before the actual deletion from the DB.

      The integration will be removed regardless if this call fails or not. @internal.

      Parameters

      • _context: OnIntegrationLifecycleInput

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods