Interface: SquidOptions
The different options that can be used to initialize a Squid instance.
Properties
apiKey
• Optional apiKey: string
The application API key, using the API key can be used to bypass security rules and other restrictions. The API key can be found in the Squid Console.
appId
• appId: string
The application ID that is used to identify the application in Squid. The ID can be found in the Squid Cloud Console.
authProvider
• Optional authProvider: SquidAuthProvider
Access token provider for the Squid instance. Used for managing the process of verifying the identity and authorization of users who attempt to access this application via the current Squid instance.
When the authProvider is set, the Squid service will fetch a token and include it with every request to the Squid backend.
On the backend, Squid will validate the access token.
environmentId
• Optional environmentId: "dev" | "prod"
The environment ID to work with, if not specified the default environment (prod) will be used.
messageNotificationWrapper
• Optional messageNotificationWrapper: (fn: () => any) => any
Type declaration
▸ (fn): any
A function that can be used to wrap messages coming from Squid to the application. This is useful for different frameworks that need to wrap messages in order to detect changes (like Angular).
Parameters
| Name | Type | Description |
|---|---|---|
fn | () => any | The function to wrap. |
Returns
any
region
• region: "us-east-1.aws" | "ap-south-1.aws" | "us-central1.gcp"
The region that the application is running in. This is used to determine the URL of the Squid API.
squidDeveloperId
• Optional squidDeveloperId: string
The user ID of the developer that runs the environment locally.