Class Modules

An executor of Modules running on Baqend.

Hierarchy

Modules

Index

Constructors

constructor

new Modules(entityManager: EntityManager): Modules
Parameters
- entityManager: EntityManager
Returns Modules
- Defined in lib/intersection/Modules.ts:16

Properties

entityManager

entityManager: EntityManager

Methods

get

get(bucket: string, query?: string | Function | {
[param: string]: string;
}, options?: Function | {
responseType?: ResponseBodyType;
}, doneCallback?: any, failCallback?: any): Promise<any>
Calls the module, which is identified by the given bucket

The optional query parameter will be attached as GET-parameters.

Returns
Parameters
- bucket: string
  
  Name of the module
- Optional query: string | Function | {
  [param: string]: string;
  }
  
  GET-Parameter as key-value-pairs or query string
- Optional options: Function | {
  responseType?: ResponseBodyType;
  }
  
  Additional request options
- Optional doneCallback: any
- Optional failCallback: any
Returns Promise<any>
- Defined in lib/intersection/Modules.ts:34

post

post(bucket: string, body?: RequestBody, options?: {
    mimeType?: string;
    requestType?: RequestBodyType;
    responseType?: ResponseBodyType;
}, doneCallback?: any, failCallback?: any): Promise<any>
Calls the module, which is identified by the given bucket

Returns
Parameters
- bucket: string
  
  Name of the module
- Optional body: RequestBody
  
  The POST-body data to send
- Optional options: {
      mimeType?: string;
      requestType?: RequestBodyType;
      responseType?: ResponseBodyType;
  }
  
  Additional request options
  - Optional mimeType?: string
    
    The mimType of the body. Defaults to the mimeType of the provided data if it is a file object, blob or data-url
  - Optional requestType?: RequestBodyType
    
    A optional type hint used to correctly interpret the provided data, can be one of arraybuffer, blob, json, text, base64, data-url, form
  - Optional responseType?: ResponseBodyType
    
    The type used to provide the response data, defaults to text oder json depends on the received data, can be one of arraybuffer, blob, json, text, base64, data-url
- Optional doneCallback: any
- Optional failCallback: any
Returns Promise<any>
- Defined in lib/intersection/Modules.ts:69

send

send(msg: Message, doneCallback?: any, failCallback?: any): Promise<any>
Parameters
- msg: Message
- Optional doneCallback: any
- Optional failCallback: any
Returns Promise<any>
- Defined in lib/intersection/Modules.ts:85

Class Modules

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

entityManager: EntityManager

Returns Modules

Properties

entityManager

Methods

get

Returns

Parameters

bucket: string

Optional query: string | Function | { [param: string]: string; }

Optional options: Function | { responseType?: ResponseBodyType; }

Optional doneCallback: any

Optional failCallback: any

Returns Promise<any>

post

Returns

Parameters

bucket: string

Optional body: RequestBody

Optional options: { mimeType?: string; requestType?: RequestBodyType; responseType?: ResponseBodyType; }

Optional mimeType?: string

Optional requestType?: RequestBodyType

Optional responseType?: ResponseBodyType

Optional doneCallback: any

Optional failCallback: any

Returns Promise<any>

send

Parameters

msg: Message

Optional doneCallback: any

Optional failCallback: any

Returns Promise<any>

Settings

Member Visibility

Theme

`Optional` query: string | Function | {
[param: string]: string;
}

`Optional` options: Function | {
responseType?: ResponseBodyType;
}

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` body: RequestBody

`Optional` options: {
mimeType?: string;
requestType?: RequestBodyType;
responseType?: ResponseBodyType;
}

`Optional` mimeType?: string

`Optional` requestType?: RequestBodyType

`Optional` responseType?: ResponseBodyType

`Optional` doneCallback: any

`Optional` failCallback: any

`Optional` doneCallback: any

`Optional` failCallback: any