Class DummyDynamoService<T>

class: DummyDynamoService

service in-memory dummy data

Type Parameters

T extends GeneralItem

Hierarchy

DynamoService<T>
- DummyDynamoService

Index

Constructors

constructor

new DummyDynamoService<T>(dataFile: string, options: DynamoOption): DummyDynamoService<T>
Type Parameters
- T extends GeneralItem
Parameters
- dataFile: string
- options: DynamoOption
Returns DummyDynamoService<T>
Overrides DynamoService.constructor
- Defined in src/cores/dynamo/dynamo-service.ts:471

Properties

`Private` buffer

buffer: { [id: string]: T } = {}

Type declaration

[id: string]: T

`Protected` options

options: DynamoOption

`Static` normalize

normalize: ((data: any) => any) = normalize

Type declaration

- (data: any): any
- export to test..
  Parameters
  - data: any
  Returns any

Methods

createTable

createTable(ReadCapacityUnits?: number, WriteCapacityUnits?: number): Promise<PromiseResult<CreateTableOutput, AWSError>>
create-table
Parameters
- ReadCapacityUnits: number = 1
- WriteCapacityUnits: number = 1
Returns Promise<PromiseResult<CreateTableOutput, AWSError>>
Inherited from DynamoService.createTable
- Defined in src/cores/dynamo/dynamo-service.ts:321

deleteItem

deleteItem(id: string, sort?: string | number): Promise<T>
delete-item
- destroy whole data of item.
Parameters
- id: string
- Optional sort: string | number
Returns Promise<T>
Overrides DynamoService.deleteItem
- Defined in src/cores/dynamo/dynamo-service.ts:523

deleteTable

deleteTable(): Promise<PromiseResult<DeleteTableOutput, AWSError>>
delete-table

Returns Promise<PromiseResult<DeleteTableOutput, AWSError>>
Inherited from DynamoService.deleteTable
- Defined in src/cores/dynamo/dynamo-service.ts:337

hello

hello(): string
say hello()

Returns string
Overrides DynamoService.hello
- Defined in src/cores/dynamo/dynamo-service.ts:492

listItems

listItems(page?: number, limit?: number): Promise<{ limit: number; list: T[]; page: number; total: number }>
ONLY FOR DUMMY
- send list of data.
Parameters
- Optional page: number
  
  page number starts from 1
- Optional limit: number
  
  limit of count.
Returns Promise<{ limit: number; list: T[]; page: number; total: number }>
- Defined in src/cores/dynamo/dynamo-service.ts:501

load

load(data: T[]): void
Parameters
- data: T[]
Returns void
- Defined in src/cores/dynamo/dynamo-service.ts:480

prepareCreateTable

prepareCreateTable(ReadCapacityUnits?: number, WriteCapacityUnits?: number, StreamEnabled?: boolean): { AttributeDefinitions: { AttributeName: string; AttributeType: any }[]; KeySchema: { AttributeName: string; KeyType: string }[]; ProvisionedThroughput: { ReadCapacityUnits: number; WriteCapacityUnits: number }; StreamSpecification: { StreamEnabled: boolean; StreamViewType: string }; TableName: string }
prepare CreateTable payload.
Parameters
- ReadCapacityUnits: number = 1
- WriteCapacityUnits: number = 1
- StreamEnabled: boolean = true
Returns { AttributeDefinitions: { AttributeName: string; AttributeType: any }[]; KeySchema: { AttributeName: string; KeyType: string }[]; ProvisionedThroughput: { ReadCapacityUnits: number; WriteCapacityUnits: number }; StreamSpecification: { StreamEnabled: boolean; StreamViewType: string }; TableName: string }
- AttributeDefinitions: { AttributeName: string; AttributeType: any }[]
- KeySchema: { AttributeName: string; KeyType: string }[]
- ProvisionedThroughput: { ReadCapacityUnits: number; WriteCapacityUnits: number }
  - ReadCapacityUnits: number
  - WriteCapacityUnits: number
- StreamSpecification: { StreamEnabled: boolean; StreamViewType: string }
  - StreamEnabled: boolean
  - StreamViewType: string
- TableName: string
Inherited from DynamoService.prepareCreateTable
- Defined in src/cores/dynamo/dynamo-service.ts:110

prepareDeleteTable

prepareDeleteTable(): { TableName: string }
prepare DeleteTable payload.

Returns { TableName: string }
- TableName: string
Inherited from DynamoService.prepareDeleteTable
- Defined in src/cores/dynamo/dynamo-service.ts:167

prepareItemKey

prepareItemKey(id: string, sort: any): { Key: {}; TableName: string }
prepare Key by id + sort key.
Parameters
- id: string
  
  partition-key
- sort: any
  
  sort-key
Returns { Key: {}; TableName: string }
- Key: {}
- TableName: string
Inherited from DynamoService.prepareItemKey
- Defined in src/cores/dynamo/dynamo-service.ts:203

prepareSaveItem

prepareSaveItem(id: string, item: T): { Item: any; TableName: string }
prepare SaveItem payload.
Parameters
- id: string
  
  partition-key
- item: T
Returns { Item: any; TableName: string }
- Item: any
- TableName: string
Inherited from DynamoService.prepareSaveItem
- Defined in src/cores/dynamo/dynamo-service.ts:181

prepareUpdateItem

prepareUpdateItem(id: string, sort: any, $update: Updatable, $increment?: Incrementable): any
prepare UpdateItem payload.
Parameters
- id: string
  
  partition-key
- sort: any
  
  sort-key
- $update: Updatable
  
  update set
- Optional $increment: Incrementable
  
  increment set.
Returns any
Inherited from DynamoService.prepareUpdateItem
- Defined in src/cores/dynamo/dynamo-service.ts:229

readItem

readItem(id: string, sort?: string | number): Promise<T>
read-item
- read whole data of item.
Parameters
- id: string
- Optional sort: string | number
Returns Promise<T>
Overrides DynamoService.readItem
- Defined in src/cores/dynamo/dynamo-service.ts:510

saveItem

saveItem(id: string, item: T): Promise<T>
save-item
- save whole data with param (use update if partial save)
WARN overwrited if exists.
Parameters
- id: string
- item: T
Returns Promise<T>
Overrides DynamoService.saveItem
- Defined in src/cores/dynamo/dynamo-service.ts:517

updateItem

updateItem(id: string, sort: string | number, updates: T, increments?: Incrementable): Promise<T>
update-item (or increment-item)
- update or create if not exists.
Parameters
- id: string
- sort: string | number
- updates: T
- Optional increments: Incrementable
Returns Promise<T>
Overrides DynamoService.updateItem
- Defined in src/cores/dynamo/dynamo-service.ts:528

`Static` instance

instance(region?: string): { dynamo: DynamoDB; dynamodoc: DocumentClient; dynamostr: DynamoDBStreams }
simple instance maker.
Parameters
- Optional region: string
  
  (default as ap-northeast-2)
Returns { dynamo: DynamoDB; dynamodoc: DocumentClient; dynamostr: DynamoDBStreams }
- dynamo: DynamoDB
- dynamodoc: DocumentClient
- dynamostr: DynamoDBStreams
Inherited from DynamoService.instance
- Defined in src/cores/dynamo/dynamo-service.ts:89

Class DummyDynamoService<T>

Type Parameters

T extends GeneralItem

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends GeneralItem

Parameters

dataFile: string

options: DynamoOption

Returns DummyDynamoService<T>

Properties

Private buffer

Type declaration

[id: string]: T

Protected options

Static normalize

Type declaration

Parameters

data: any

Returns any

Methods

createTable

Parameters

ReadCapacityUnits: number = 1

WriteCapacityUnits: number = 1

Returns Promise<PromiseResult<CreateTableOutput, AWSError>>

deleteItem

Parameters

id: string

Optional sort: string | number

Returns Promise<T>

deleteTable

Returns Promise<PromiseResult<DeleteTableOutput, AWSError>>

hello

Returns string

listItems

Parameters

Optional page: number

Optional limit: number

Returns Promise<{ limit: number; list: T[]; page: number; total: number }>

load

Parameters

data: T[]

Returns void

prepareCreateTable

Parameters

ReadCapacityUnits: number = 1

WriteCapacityUnits: number = 1

StreamEnabled: boolean = true

AttributeDefinitions: { AttributeName: string; AttributeType: any }[]

KeySchema: { AttributeName: string; KeyType: string }[]

ProvisionedThroughput: { ReadCapacityUnits: number; WriteCapacityUnits: number }

ReadCapacityUnits: number

WriteCapacityUnits: number

StreamSpecification: { StreamEnabled: boolean; StreamViewType: string }

StreamEnabled: boolean

StreamViewType: string

TableName: string

prepareDeleteTable

Returns { TableName: string }

TableName: string

prepareItemKey

Parameters

id: string

sort: any

Returns { Key: {}; TableName: string }

Key: {}

TableName: string

prepareSaveItem

Parameters

id: string

item: T

Returns { Item: any; TableName: string }

Item: any

`Private` buffer

`Protected` options

`Static` normalize

`Optional` sort: string | number

`Optional` page: number

`Optional` limit: number

`Optional` $increment: Incrementable

`Optional` sort: string | number

`Optional` increments: Incrementable

`Static` instance

`Optional` region: string