Class Connection

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

Hierarchy

Connection

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): Connection
Parameters
- options: ConnectionOptions
Returns Connection
- Defined in packages/ngw-orm/src/connection/Connection.ts:43

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 packages/ngw-orm/src/connection/Connection.ts:89

createResource

createResource(Resource, options): Promise<typeof BaseResource>
Parameters
- Resource: typeof BaseResource
- options: SyncOptions
Returns Promise<typeof BaseResource>
- Defined in packages/ngw-orm/src/connection/Connection.ts:109

deleteResource

deleteResource(resource): Promise<void>
Parameters
- resource: typeof BaseResource
Returns Promise<void>
- Defined in packages/ngw-orm/src/connection/Connection.ts:155

getOrCreateResource

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

getResource

getResource(resource): Promise<undefined | ResourceItem>
Deprecated
use getResourceItem instead
Parameters
- resource: ResourceIdKeynameDef | DeepPartial<Resource>
Returns Promise<undefined | ResourceItem>
- Defined in packages/ngw-orm/src/connection/Connection.ts:145

getResourceItem

getResourceItem(resource): Promise<undefined | ResourceItem>
Parameters
- resource: ResourceIdKeynameDef | DeepPartial<Resource>
Returns Promise<undefined | ResourceItem>
- Defined in packages/ngw-orm/src/connection/Connection.ts:136

getResourceNgwPayload

getResourceNgwPayload(resource, parent, opt?): undefined | DeepPartial<ResourceSyncItem<Record<string, any>>>
Parameters
- resource: typeof BaseResource
- parent: number
- opt: Partial<SyncOptions> = {}
Returns undefined | DeepPartial<ResourceSyncItem<Record<string, any>>>
- Defined in packages/ngw-orm/src/connection/Connection.ts:166

receiveResource

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

updateResource

updateResource(Resource): Promise<void>
Parameters
- Resource: typeof BaseResource
Returns Promise<void>
- Defined in packages/ngw-orm/src/connection/Connection.ts:117

`Static` connect

connect(options): Promise<Connection>
Parameters
- options: Connection | ConnectionOptions
Returns Promise<Connection>
- Defined in packages/ngw-orm/src/connection/Connection.ts:71

`Static` create

create(options): Connection
Parameters
- options: Connection | ConnectionOptions
Returns Connection
- Defined in packages/ngw-orm/src/connection/Connection.ts:51

Generated using TypeDoc