Class SquidService

apiKeys

• get apiKeys(): Record<string, string>

  The list of your application's api keys.

  Returns Record<string, string>

assetsDirectory

• get assetsDirectory(): string

  Returns the assets directory for your application.

  Returns string

  the assets directory for your application.

context

• get context(): RunContext

  The context object for the current request. This object contains information about the current request, such as the current user, the IP address, the user agent used, the request headers, and more.

  Returns RunContext

secrets

• get secrets(): Record<string, SecretValue>

  The list of your application's secrets as defined in the Squid Console.

  Returns Record<string, SecretValue>

squid

• get squid(): Squid

  Returns the Squid client instance for your application.

  Returns Squid

  the Squid client instance for your application.

constructor

• new SquidService(): SquidService

  Returns SquidService

assertApiKeyCall

• assertApiKeyCall(): void

  Asserts that the current method call includes an API key in the context. Throws an error if called without an API key.

  Returns void

assertInRequestScope

• assertInRequestScope(): void

  Asserts that the method is called within a valid request scope. Throws an error if no request context can be found.

  Returns void

assertIsAuthenticated

• assertIsAuthenticated(): void

  Asserts that the current request is authenticated (using a user token or an API key).

  Returns void

  Throws

  UNAUTHORIZED if the current request is not authenticated.

convertToSquidFile

• convertToSquidFile(file: File): Promise<SquidFile>

  Converts a file to a SquidFile object. This function is useful when you want to return a file using OpenAPI (tsoa decorators).

  Parameters

  • file: File

  Returns Promise<SquidFile>

createOpenApiResponse

• createOpenApiResponse(
      body?: unknown,
      statusCode?: number,
      headers?: Record<string, unknown>,
  ): any

  Constructs a response for an OpenAPI operation. This function is typically used within an OpenAPI handler.

  Parameters

  • Optionalbody: unknown

    The payload of the response. If not provided, defaults to an empty string.
  • OptionalstatusCode: number

    The HTTP status code for the response. Defaults to 200 if a body is present, otherwise 204.
  • Optionalheaders: Record<string, unknown>

    An object containing response headers. Defaults to an empty object if not provided.

  Returns any

  The openapi response.

createWebhookResponse

• createWebhookResponse(
      body?: unknown,
      statusCode?: number,
      headers?: Record<string, unknown>,
  ): any

  A helper method to create a webhook response. This method should be used inside a webhook handler (function decorated with @webhook).

  Parameters

  • Optionalbody: unknown

    The body of the response.
  • OptionalstatusCode: number

    The status code of the response.
  • Optionalheaders: Record<string, unknown>

    The headers of the response.

  Returns any

  The webhook response.

getApiKey

• getApiKey(): string

  Returns the API key used by the backend for your application.

  Returns string

getApiKeyAuth

• getApiKeyAuth(): undefined | AuthWithApiKey

  Returns the auth object for the current request or undefined if unauthenticated or if using a user token.

  Returns undefined | AuthWithApiKey

  The auth object for the current request or undefined if unauthenticated or if using a user token.

getUserAuth

• getUserAuth(): undefined | AuthWithBearer

  Returns the auth object for the current request or undefined if unauthenticated or if using an API key.

  Returns undefined | AuthWithBearer

  The auth object for the current request or undefined if unauthenticated or if using an API key.

isAuthenticated

• isAuthenticated(): boolean

  Returns true if the current request is authenticated (using a user token or an API key).

  Returns boolean

  true if the current request is authenticated (using a user token or an API key).

throwOpenApiResponse

• throwOpenApiResponse(
      content: Partial<
          { body: unknown; headers: Record<string, unknown>; statusCode: number },
      >,
  ): never

  Throws an OpenAPI response. This function is useful when you want to interrupt normal execution and immediately return a response from an OpenAPI handler.

  Parameters

  • content: Partial<{ body: unknown; headers: Record<string, unknown>; statusCode: number }>

    The response content including optional body, status code, and headers.

  Returns never

  Throws

  An object marked as an OpenAPI response.

throwWebhookResponse

• throwWebhookResponse(
      content: Partial<
          { body: unknown; headers: Record<string, unknown>; statusCode: number },
      >,
  ): never

  Throws a webhook response. This function is useful when you want to interrupt normal execution and immediately return a response from a webhook handler.

  Parameters

  • content: Partial<{ body: unknown; headers: Record<string, unknown>; statusCode: number }>

    The response content including optional body, status code, and headers.

  Returns never

  Throws

  An object marked as a webhook response.

ReadonlybackendBaseUrl

Readonlyregion