Class Apex<S>

API class for Apex REST endpoint call

Type Parameters

S extends Schema

Index

Constructors

Properties

Methods

_baseUrl delete get patch post put

Constructors

constructor

new Apex<S>(conn): Apex<S>
Type Parameters
- S extends Schema
Parameters
- conn: Connection<S>
Returns Apex<S>
- Defined in src/api/apex.ts:18

Properties

_conn

_conn: Connection<S>

del

del: (<R>(path, options?) => StreamPromise<R>) = ...

Synonym of Apex#delete()

Type declaration

- <R>(path, options?): StreamPromise<R>
- Type Parameters
  - R = unknown
  Parameters
  - path: string
  - Optional options: Object
  Returns StreamPromise<R>

Methods

_baseUrl

_baseUrl(): string
Returns string
- Defined in src/api/apex.ts:23

delete

delete<R>(path, options?): StreamPromise<R>
Call Apex REST service in DELETE request
Type Parameters
- R = unknown
Parameters
- path: string
- Optional options: Object
Returns StreamPromise<R>
- Defined in src/api/apex.ts:88

get

get<R>(path, options?): StreamPromise<R>
Call Apex REST service in GET request
Type Parameters
- R = unknown
Parameters
- path: string
- Optional options: Object
Returns StreamPromise<R>
- Defined in src/api/apex.ts:55

patch

patch<R>(path, body?, options?): StreamPromise<R>
Call Apex REST service in PATCH request
Type Parameters
- R = unknown
Parameters
- path: string
- Optional body: Object
- Optional options: Object
Returns StreamPromise<R>
- Defined in src/api/apex.ts:80

post

post<R>(path, body?, options?): StreamPromise<R>
Call Apex REST service in POST request
Type Parameters
- R = unknown
Parameters
- path: string
- Optional body: Object
- Optional options: Object
Returns StreamPromise<R>
- Defined in src/api/apex.ts:64

put

put<R>(path, body?, options?): StreamPromise<R>
Call Apex REST service in PUT request
Type Parameters
- R = unknown
Parameters
- path: string
- Optional body: Object
- Optional options: Object
Returns StreamPromise<R>
- Defined in src/api/apex.ts:72