Class FunctionsClient

Hierarchy

FunctionsClient

Index

Constructors

constructor

new FunctionsClient(url: string, __namedParameters?: {
    customFetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    };
    headers?: Record<string, string>;
    region?: FunctionRegion;
}): FunctionsClient
Parameters
- url: string
- __namedParameters: {
      customFetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      headers?: Record<string, string>;
      region?: FunctionRegion;
  } = {}
  - Optional customFetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
    - (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
      
      Parameters
      
      input: RequestInfo | URL
      
      Optional init: RequestInit
      
      Returns Promise<Response>
      
      (input: string | Request | URL, init?: RequestInit): Promise<Response>
      
      Parameters
      
      input: string | Request | URL
      
      Optional init: RequestInit
      
      Returns Promise<Response>
  - Optional headers?: Record<string, string>
  - Optional region?: FunctionRegion
Returns FunctionsClient
- Defined in src/FunctionsClient.ts:18

Properties

`Protected` fetch

fetch: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

Type declaration

- (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
- Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>
- (input: string | Request | URL, init?: RequestInit): Promise<Response>
- Parameters
  - input: string | Request | URL
  - Optional init: RequestInit
  Returns Promise<Response>

`Protected` headers

headers: Record<string, string>

`Protected` region

region: FunctionRegion

`Protected` url

url: string

Methods

invoke

invoke<T>(functionName: string, options?: FunctionInvokeOptions): Promise<FunctionsResponse<T>>
Invokes a function
Type Parameters
- T = any
Parameters
- functionName: string
  
  The name of the Function to invoke.
- options: FunctionInvokeOptions = {}
  
  Options for invoking the Function.
Returns Promise<FunctionsResponse<T>>
- Defined in src/FunctionsClient.ts:49

setAuth

setAuth(token: string): void
Updates the authorization header
Parameters
- token: string
  
  the new jwt token sent in the authorisation header
Returns void
- Defined in src/FunctionsClient.ts:40

Class FunctionsClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

__namedParameters: { customFetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>; }; headers?: Record<string, string>; region?: FunctionRegion; } = {}

Optional customFetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>; }

Parameters

input: RequestInfo | URL

Optional init: RequestInit

Returns Promise<Response>

Parameters

input: string | Request | URL

Optional init: RequestInit

Returns Promise<Response>

Optional headers?: Record<string, string>

Optional region?: FunctionRegion

Returns FunctionsClient

Properties

Protected fetch

Type declaration

Parameters

input: RequestInfo | URL

Optional init: RequestInit

Returns Promise<Response>

Parameters

input: string | Request | URL

Optional init: RequestInit

Returns Promise<Response>

Protected headers

Protected region

Protected url

Methods

invoke

Type Parameters

T = any

Parameters

functionName: string

options: FunctionInvokeOptions = {}

Returns Promise<FunctionsResponse<T>>

setAuth

Parameters

token: string

Returns void

Settings

Member Visibility

Theme

__namedParameters: {
customFetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
};
headers?: Record<string, string>;
region?: FunctionRegion;
} = {}

`Optional` customFetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional` init: RequestInit

`Optional` init: RequestInit

`Optional` headers?: Record<string, string>

`Optional` region?: FunctionRegion

`Protected` fetch

`Optional` init: RequestInit

`Optional` init: RequestInit

`Protected` headers

`Protected` region

`Protected` url