DynamoStore | @shiftcoders/dynamo-easy

Type parameters

T

Hierarchy

DynamoStore

Index

Constructors

constructor

Properties

tableName

Accessors

dynamoDB

Methods

Constructors

constructor

new DynamoStore(modelClazz: ModelConstructor<T>, dynamoDB: DynamoDB): DynamoStore

- Defined in dynamo/dynamo-store.ts:31
Parameters
- modelClazz: ModelConstructor<T>
- Optional dynamoDB: DynamoDB
Returns DynamoStore

Properties

tableName

tableName: string

Accessors

dynamoDB

dynamoDB:

Methods

batchGet

batchGet(keys: Array<Partial<T>>): BatchGetSingleTableRequest<T>

- Defined in dynamo/dynamo-store.ts:69
Parameters
- keys: Array<Partial<T>>
Returns BatchGetSingleTableRequest<T>

batchWrite

batchWrite(): BatchWriteSingleTableRequest<T>

- Defined in dynamo/dynamo-store.ts:78
Returns BatchWriteSingleTableRequest<T>

delete

delete(partitionKey: any, sortKey: any): DeleteRequest<T>

- Defined in dynamo/dynamo-store.ts:52
Parameters
- partitionKey: any
- Optional sortKey: any
Returns DeleteRequest<T>

get

get(partitionKey: any, sortKey: any): GetRequest<T>

- Defined in dynamo/dynamo-store.ts:44
Parameters
- partitionKey: any
- Optional sortKey: any
Returns GetRequest<T>

makeRequest

makeRequest<Z>(operation: DynamoApiOperations, params: Record<string, any>): Promise<Z>

- Defined in dynamo/dynamo-store.ts:86
Type parameters
- Z
Parameters
- operation: DynamoApiOperations
- Optional params: Record<string, any>
Returns Promise<Z>

put

put(item: T): PutRequest<T>

- Defined in dynamo/dynamo-store.ts:40
Parameters
- item: T
Returns PutRequest<T>

query

query(): QueryRequest<T>

- Defined in dynamo/dynamo-store.ts:60
Returns QueryRequest<T>

scan

scan(): ScanRequest<T>

- Defined in dynamo/dynamo-store.ts:56
Returns ScanRequest<T>

transactGet

transactGet(keys: Array<Partial<T>>): TransactGetSingleTableRequest<T>

- Defined in dynamo/dynamo-store.ts:82
Parameters
- keys: Array<Partial<T>>
Returns TransactGetSingleTableRequest<T>

update

update(partitionKey: any, sortKey: any): UpdateRequest<T>

- Defined in dynamo/dynamo-store.ts:48
Parameters
- partitionKey: any
- Optional sortKey: any
Returns UpdateRequest<T>