FuseDsSDK

@appfire/fuse-datastore-client / Exports / FuseDsSDK

Class: FuseDsSDK

Table of contents

Constructors

• constructor

Properties

• cacheKey
• dsConfig

Methods

• bulkUpdate
• bulkUpdateSub
• deleteItem
• deleteItemProperties
• getAuthToken
• getItem
• getItems
• getItemsWithGSI
• setItem
• setNestedItemProperty
• withTokenFn

Constructors

constructor

• new FuseDsSDK(dsConfig)

Parameters

Name	Type	Description
dsConfig	DsServiceConfig	, a configuration object that contains the appKey, productType and domain

Defined in

datastore.ts:37

Properties

cacheKey

• Private Readonly cacheKey: string

Defined in

datastore.ts:30

---

dsConfig

• Private dsConfig: DsServiceConfig

Defined in

datastore.ts:29

Methods

bulkUpdate

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

Parameters

Name	Type
entity	string
entity_id	string
filters	string
updateProps	string

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:186

---

bulkUpdateSub

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

Parameters

Name	Type
onSubscribeHandler	(data: any) => void
onError	(error: any) => void
onComplete?	() => void

Returns

Promise<void>

Defined in

datastore.ts:240

---

deleteItem

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

Parameters

Name	Type
entity	string
entity_id	string

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:224

---

deleteItemProperties

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

Parameters

Name	Type
entity	string
entity_id	string
prop_keys	string[]

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:206

---

getAuthToken

▸ getAuthToken(): Promise<string>

Returns

Promise<string>

Defined in

datastore.ts:67

---

getItem

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

Parameters

Name	Type
entity	string
entity_id	string
prop_keys	string[]

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:81

---

getItems

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

Parameters

Name	Type
entity	string
entity_id	undefined | string
propKeys	string[]
filters	string

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:99

---

getItemsWithGSI

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

Parameters

Name	Type
entity	string
entity_id	string
gsi	string
gsiPk	string
propKeys	string[]
filters	string

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:162

---

setItem

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

Parameters

Name	Type	Default value
entity	string	undefined
entity_id	string	undefined
props	string	undefined
permissionTemplate	PermissionTemplate	PermissionTemplate.WRITE_ADMIN_READ_ALL

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:122

---

setNestedItemProperty

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

Parameters

Name	Type
entity	string
entity_id	string
propKey	string
propVal	string

Returns

Promise<GraphQLResult<any>>

Defined in

datastore.ts:142

---

withTokenFn

▸ withTokenFn(tokenFn): FuseDsSDK

Parameters

Name	Type	Description
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:62