Class Connection

Connection is a single NGW connection. You can have multiple connections to multiple NGW in your application.

Index

Constructors

Properties

baseUrl driver isConnected options connections

Methods

connect createResource deleteResource getOrCreateResource getResource getResourceItem getResourceNgwPayload receiveResource updateResource connect create

Constructors

constructor

new Connection(options: ConnectionOptions): Connection
Parameters
- options: ConnectionOptions
Returns Connection
- Defined in connection/Connection.ts:46

Properties

`Readonly`baseUrl

baseUrl: string

Connection url.

`Readonly`driver

driver: default

NGW driver used by this connection.

`Readonly`isConnected

isConnected: boolean

Indicates if connection is initialized or not.

`Readonly`options

options: ConnectionOptions

Connection options.

`Static`connections

connections: Connection[] = []

Methods

connect

connect(): Promise<Connection>
Returns Promise<Connection>
- Defined in connection/Connection.ts:92

createResource

createResource(
Resource: typeof BaseResource,
options: SyncOptions,
): Promise<typeof BaseResource>
Parameters
- Resource: typeof BaseResource
- options: SyncOptions
Returns Promise<typeof BaseResource>
- Defined in connection/Connection.ts:112

deleteResource

deleteResource(resource: typeof BaseResource): Promise<void>
Parameters
- resource: typeof BaseResource
Returns Promise<void>
- Defined in connection/Connection.ts:158

getOrCreateResource

getOrCreateResource<P extends typeof BaseResource>(
Resource: P,
options: SyncOptions,
): Promise<[P, boolean]>
Type Parameters
- P extends typeof BaseResource
Parameters
- Resource: P
- options: SyncOptions
Returns Promise<[P, boolean]>
- Defined in connection/Connection.ts:100

getResource

getResource(
resource: ResourceIdKeynameDef | ResourceRead,
): Promise<undefined | CompositeRead>
Parameters
- resource: ResourceIdKeynameDef | ResourceRead
Returns Promise<undefined | CompositeRead>
Deprecated
use getResourceItem instead
- Defined in connection/Connection.ts:148

getResourceItem

getResourceItem(
resource: ResourceIdKeynameDef | ResourceRead,
): Promise<undefined | CompositeRead>
Parameters
- resource: ResourceIdKeynameDef | ResourceRead
Returns Promise<undefined | CompositeRead>
- Defined in connection/Connection.ts:139

getResourceNgwPayload

getResourceNgwPayload(
    resource: typeof BaseResource,
    parent: number,
    opt?: Partial<SyncOptions>,
): undefined | CompositeCreate
Parameters
- resource: typeof BaseResource
- parent: number
- opt: Partial<SyncOptions> = {}
Returns undefined | CompositeCreate
- Defined in connection/Connection.ts:169

receiveResource

receiveResource<P extends Record<string, any> = any>(
resource: ResourceIdKeynameDef,
): Promise<typeof BaseResource & P>
Type Parameters
- P extends Record<string, any> = any
Parameters
- resource: ResourceIdKeynameDef
Returns Promise<typeof BaseResource & P>
- Defined in connection/Connection.ts:79

updateResource

updateResource(Resource: typeof BaseResource): Promise<void>
Parameters
- Resource: typeof BaseResource
Returns Promise<void>
- Defined in connection/Connection.ts:120

`Static`connect

connect(options: Connection | ConnectionOptions): Promise<Connection>
Parameters
- options: Connection | ConnectionOptions
Returns Promise<Connection>
- Defined in connection/Connection.ts:74

`Static`create

create(options: Connection | ConnectionOptions): Connection
Parameters
- options: Connection | ConnectionOptions
Returns Connection
- Defined in connection/Connection.ts:54