Class Executable<T>`Abstract`

Abstract class that defines the required functions to properly invoke a BambuMeta request from a client application.

Type Parameters

T

Index

Constructors

Methods

getBody getMethod getResponse getRootPath getURLPath prepareRequest

Constructors

constructor

new Executable<T>(): Executable<T>
Type Parameters
- T
Returns Executable<T>

Methods

`Abstract` getBody

getBody(): any
This function returns any body object that would be passed to the API request.

Returns any
- Defined in src/executable.ts:16

`Abstract` getMethod

getMethod(): Method
The rest function method to invoke the api with.

Returns Method
- Defined in src/executable.ts:28

`Abstract` getResponse

getResponse(apiResponse): T
This returns the proper response type for the execute function.
Parameters
- apiResponse: any
  
  The response from the API request.
Returns T
- Defined in src/executable.ts:35

`Abstract` getRootPath

getRootPath(): undefined | string
This function overloads the default rootPath for the API request.

Returns undefined | string
- Defined in src/executable.ts:40

`Abstract` getURLPath

getURLPath(tenantId?): string
The URL path to invoke.
Parameters
- Optional tenantId: string
  
  The tenantId provided by the BambuMeta client.
Returns string
- Defined in src/executable.ts:23

prepareRequest

prepareRequest(options): Promise<any>
Parameters
- options: {
  execute: ((executable) => Promise<any>);
  }
  - execute: ((executable) => Promise<any>)
    - (executable): Promise<any>
      
      Parameters
      
      executable: Executable<any>
      
      Returns Promise<any>
Returns Promise<any>
- Defined in src/executable.ts:9

Generated using TypeDoc