Skip to main content

FuseDsSDK

@appfire/fuse-datastore-client • Docs

@appfire/fuse-datastore-client / FuseDsSDK

Class: FuseDsSDK

Constructors​

new FuseDsSDK()​

new FuseDsSDK(dsConfig): FuseDsSDK

Parameters​

• dsConfig: DsServiceConfig

, a configuration object that contains the appKey, productType and domain

Returns​

FuseDsSDK

FuseDsSDK instance

Defined in​

datastore.ts:37

Methods​

bulkUpdate()​

bulkUpdate(entity, entity_id, filters, updateProps): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• filters: string

• updateProps: string

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:191

bulkUpdateSub()​

bulkUpdateSub(onSubscribeHandler, onError, onComplete?): Promise\<void>

Parameters​

• onSubscribeHandler

• onError

• onComplete?

Returns​

Promise\<void>

Defined in​

datastore.ts:245

deleteItem()​

deleteItem(entity, entity_id): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:229

deleteItemProperties()​

deleteItemProperties(entity, entity_id, prop_keys): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• prop_keys: string[]

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:211

getAuthToken()​

getAuthToken(): Promise\<string>

Returns​

Promise\<string>

Defined in​

datastore.ts:66

getItem()​

getItem(entity, entity_id, prop_keys): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• prop_keys: string[]

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:86

getItems()​

getItems(entity, entity_id, propKeys, filters): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: undefined | string

• propKeys: string[]

• filters: string

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:104

getItemsWithGSI()​

getItemsWithGSI(entity, entity_id, gsi, gsiPk, propKeys, filters): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• gsi: string

• gsiPk: string

• propKeys: string[]

• filters: string

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:167

setItem()​

setItem(entity, entity_id, props, permissionTemplate): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• props: string

• permissionTemplate: PermissionTemplate = PermissionTemplate.WRITE_ADMIN_READ_ALL

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:127

setNestedItemProperty()​

setNestedItemProperty(entity, entity_id, propKey, propVal): Promise\<GraphQLResult\<any>>

Parameters​

• entity: string

• entity_id: string

• propKey: string

• propVal: string

Returns​

Promise\<GraphQLResult\<any>>

Defined in​

datastore.ts:147

withTokenFn()​

withTokenFn(tokenFn): FuseDsSDK

Parameters​

• tokenFn: TokenFunction

, a function that returns a valid fuse token this would be cached and used in Datastore requests

Returns​

FuseDsSDK

Defined in​

datastore.ts:61