Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

References

Enumerations

Interfaces

Type aliases

References

AccessOptions

Re-exports AccessOptions

AccountSidConfig

Re-exports AccountSidConfig

ActivateConfig

Re-exports ActivateConfig

ActivateResult

Re-exports ActivateResult

AssetApiResource

Re-exports AssetApiResource

AssetList

Re-exports AssetList

AssetResource

Re-exports AssetResource

AssetVersion

Re-exports AssetVersion

BaseList

Re-exports BaseList

BuildConfig

Re-exports BuildConfig

BuildList

Re-exports BuildList

BuildResource

Re-exports BuildResource

BuildStatus

Re-exports BuildStatus

BuildStatusResource

Re-exports BuildStatusResource

ClientConfig

Re-exports ClientConfig

Dependency

Re-exports Dependency

DeployLocalProjectConfig

Re-exports DeployLocalProjectConfig

DeployProjectConfig

Re-exports DeployProjectConfig

DeployResult

Re-exports DeployResult

DirectoryContent

Re-exports DirectoryContent

EnvironmentList

Re-exports EnvironmentList

EnvironmentResource

Re-exports EnvironmentResource

EnvironmentVariables

Re-exports EnvironmentVariables

FileInfo

Re-exports FileInfo

FunctionApiResource

Re-exports FunctionApiResource

FunctionContent

Re-exports FunctionContent

FunctionList

Re-exports FunctionList

FunctionResource

Re-exports FunctionResource

FunctionVersion

Re-exports FunctionVersion

GetEnvironmentVariablesConfig

Re-exports GetEnvironmentVariablesConfig

GetEnvironmentVariablesResult

Re-exports GetEnvironmentVariablesResult

GotClient

Re-exports GotClient

KeyValue

Re-exports KeyValue

ListConfig

Re-exports ListConfig

ListOptions

Re-exports ListOptions

ListResult

Re-exports ListResult

LogApiResource

Re-exports LogApiResource

LogFilters

Re-exports LogFilters

LogList

Re-exports LogList

LogsConfig

Re-exports LogsConfig

RemoveEnvironmentVariablesConfig

Re-exports RemoveEnvironmentVariablesConfig

RemoveEnvironmentVariablesResult

Re-exports RemoveEnvironmentVariablesResult

ResourceBase

Re-exports ResourceBase

ResourcePathAndAccess

Re-exports ResourcePathAndAccess

ServerlessResourceConfig

Re-exports ServerlessResourceConfig

ServerlessResourceConfigWithFilePath

Re-exports ServerlessResourceConfigWithFilePath

ServiceList

Re-exports ServiceList

ServiceResource

Re-exports ServiceResource

SetEnvironmentVariablesConfig

Re-exports SetEnvironmentVariablesConfig

SetEnvironmentVariablesResult

Re-exports SetEnvironmentVariablesResult

Sid

Re-exports Sid

StatusUpdate

Re-exports StatusUpdate

StatusUpdateCallback

Re-exports StatusUpdateCallback

UpdateableResourceBase

Re-exports UpdateableResourceBase

UsernameConfig

Re-exports UsernameConfig

Variable

Re-exports Variable

VariableList

Re-exports VariableList

VariableResource

Re-exports VariableResource

VersionOnBuild

Re-exports VersionOnBuild

VersionResource

Re-exports VersionResource

Type aliases

AccessOptions

AccessOptions: "private" | "protected" | "public"

AccountSidConfig

AccountSidConfig: BaseClientConfig & { accountSid: string; authToken: string }

ActivateConfig

ActivateConfig: ClientConfig & { buildSid?: Sid; createEnvironment?: undefined | false | true; env: EnvironmentVariables; force?: undefined | false | true; serviceSid: Sid; sourceEnvironment?: string | Sid; targetEnvironment: string | Sid }

ActivateResult

ActivateResult: { buildSid: Sid; domain: string; environmentSid: Sid; serviceSid: Sid }

Type declaration

  • buildSid: Sid
  • domain: string
  • environmentSid: Sid
  • serviceSid: Sid

AssetResource

AssetResource: ServerlessResourceConfig & { sid: string } & Partial<ServerlessResourceConfigWithFilePath>

BuildConfig

BuildConfig: { assetVersions?: Sid[]; dependencies?: Dependency[]; functionVersions?: Sid[]; runtime?: undefined | string }

Type declaration

  • Optional assetVersions?: Sid[]
  • Optional dependencies?: Dependency[]
  • Optional functionVersions?: Sid[]
  • Optional runtime?: undefined | string

BuildStatus

BuildStatus: "building" | "completed" | "failed"

ClientConfig

Config to set up a API request client

Dependency

Dependency: { name: string; version: string }

Type declaration

  • name: string
  • version: string

DeployLocalProjectConfig

DeployLocalProjectConfig: ClientConfig & DeployProjectConfigBase & { assetsFolderName?: undefined | string; cwd: string; envPath: string; functionsFolderName?: undefined | string; noAssets?: undefined | false | true; noFunctions?: undefined | false | true }

Config for client.deployLocalProject

DeployProjectConfig

DeployProjectConfig: ClientConfig & DeployProjectConfigBase & { assets: ServerlessResourceConfig[]; functions: ServerlessResourceConfig[] }

Config for client.deployProject

DeployResult

DeployResult: { assetResources: AssetResource[]; buildSid: Sid; domain: string; environmentSid: Sid; functionResources: FunctionResource[]; runtime: string; serviceName: string; serviceSid: Sid }

Type declaration

DirectoryContent

EnvironmentVariables

EnvironmentVariables: {}

Type declaration

  • [key: string]: string | undefined

FileInfo

FileInfo: { name: string; path: string }

Type declaration

  • name: string
  • path: string

FunctionContent

FunctionContent: { account_sid: Sid; content: string; function_sid: Sid; service_sid: Sid; sid: Sid; url: string }

Type declaration

  • account_sid: Sid
  • content: string
  • function_sid: Sid
  • service_sid: Sid
  • sid: Sid
  • url: string

FunctionResource

FunctionResource: ServerlessResourceConfig & { sid: string } & Partial<ServerlessResourceConfigWithFilePath>

GetEnvironmentVariablesConfig

GetEnvironmentVariablesConfig: ClientConfig & { environment: string | Sid; getValues: boolean; keys: string[]; serviceName?: undefined | string; serviceSid?: undefined | string }

GetEnvironmentVariablesResult

GetEnvironmentVariablesResult: { environmentSid: Sid; serviceSid: Sid; variables: KeyValue[] }

Type declaration

GotClient

GotClient: Got

KeyValue

KeyValue: { key: string; value?: undefined | string }

Type declaration

  • key: string
  • Optional value?: undefined | string

ListConfig

ListConfig: ClientConfig & { environment?: string | Sid; serviceName?: undefined | string; serviceSid?: undefined | string; types: ListOptions | ListOptions[] }

Config used for client.list

ListOptions

ListOptions: "environments" | "services" | "variables" | "builds" | "functions" | "assets"

Available types to list

ListResult

ListResult: { assets?: undefined | { entries: AssetVersion[]; environmentSid: string }; builds?: BuildResource[]; environments?: EnvironmentResource[]; functions?: undefined | { entries: FunctionVersion[]; environmentSid: string }; services?: ServiceResource[]; variables?: undefined | { entries: VariableResource[]; environmentSid: string } }

Type declaration

LogFilters

LogFilters: { endDate?: string | Date; functionSid?: Sid; pageSize?: undefined | number; pageToken?: undefined | string; startDate?: string | Date }

Type declaration

  • Optional endDate?: string | Date
  • Optional functionSid?: Sid
  • Optional pageSize?: undefined | number
  • Optional pageToken?: undefined | string
  • Optional startDate?: string | Date

LogsConfig

LogsConfig: { environment: string | Sid; filterByFunction?: string | Sid; limit?: undefined | number; logCacheSize?: undefined | number; pollingFrequency?: undefined | number; serviceSid: Sid; tail: boolean }

Type declaration

  • environment: string | Sid
  • Optional filterByFunction?: string | Sid
  • Optional limit?: undefined | number
  • Optional logCacheSize?: undefined | number
  • Optional pollingFrequency?: undefined | number
  • serviceSid: Sid
  • tail: boolean

RemoveEnvironmentVariablesConfig

RemoveEnvironmentVariablesConfig: ClientConfig & { environment: string | Sid; keys: string[]; serviceName?: undefined | string; serviceSid?: undefined | string }

RemoveEnvironmentVariablesResult

RemoveEnvironmentVariablesResult: { environmentSid: Sid; serviceSid: Sid }

Type declaration

  • environmentSid: Sid
  • serviceSid: Sid

ResourcePathAndAccess

ResourcePathAndAccess: { access: AccessOptions; path: string }

Type declaration

ServerlessResourceConfig

ServerlessResourceConfig: { access: AccessOptions; content: string | Buffer; name: string; path: string }

Necessary info to deploy a function

Type declaration

  • access: AccessOptions

    Access for the function

  • content: string | Buffer

    Content of the uploaded function

  • name: string

    Function name

  • path: string

    Path for the serverless resource Functions: '/some-function' Assets: '/some-assets.jpg'

ServerlessResourceConfigWithFilePath

ServerlessResourceConfigWithFilePath: ServerlessResourceConfig & { filePath: string }

SetEnvironmentVariablesConfig

SetEnvironmentVariablesConfig: ClientConfig & { append: boolean; env: EnvironmentVariables; environment: string | Sid; serviceName?: undefined | string; serviceSid?: undefined | string }

SetEnvironmentVariablesResult

SetEnvironmentVariablesResult: { environmentSid: Sid; serviceSid: Sid }

Type declaration

  • environmentSid: Sid
  • serviceSid: Sid

Sid

Sid: string

StatusUpdate

StatusUpdate: { message: string; status: DeployStatus }

Type declaration

StatusUpdateCallback

StatusUpdateCallback: (update: StatusUpdate) => void

Type declaration

UsernameConfig

UsernameConfig: BaseClientConfig & { password: string; username: string }

Variable

Variable: { key: string; value: string }

Type declaration

  • key: string
  • value: string

Generated using TypeDoc