controller-manager

@raydeck/controller-manager - v1.13.0

@raydeck/controller-manager - v1.13.0

Index

Classes

• Base
• DDBBase
• Event
• Lookup
• Lookupable
• Relationship

Type aliases

• CancelRunLater
• MakeEvent
• RunLater

Variables

• cancelRunLater
• makeEvent
• runLater

Functions

• _clear
• _clearValue
• clear
• clearValue
• get
• getIdsObjects
• getIdsPage
• getObject
• getUri
• getValuesObjects
• getValuesPage
• make
• makeAddListener
• page
• remove
• removeObject
• removeUri
• set
• setCancelRunLater
• setMakeEvent
• setObject
• setRunLater
• setUri

Type aliases

CancelRunLater

Ƭ CancelRunLater: function

Defined in Base.ts:22

Type declaration:

▸ (uri: string, event: string): Promise‹void›

Parameters:

Name | Type | ------ | ------ | uri | string | event | string |

MakeEvent

Ƭ MakeEvent: function

Defined in Base.ts:6

Type declaration:

▸ (params: object): Promise‹void›

Parameters:

▪ params: object

Name | Type | ------ | ------ | context? | undefined | object | date? | Date | event | string | uri | string |

RunLater

Ƭ RunLater: function

Defined in Base.ts:16

Type declaration:

▸ (uri: string, event: string, when: Date, context?: undefined | object): Promise‹void›

Parameters:

Name | Type | ------ | ------ | uri | string | event | string | when | Date | context? | undefined | object |

Variables

Let cancelRunLater

• cancelRunLater: undefined | CancelRunLater

Defined in Base.ts:24

Let makeEvent

• makeEvent: undefined | MakeEvent

Defined in Base.ts:12

Let runLater

• runLater: undefined | RunLater

Defined in Base.ts:23

Functions

_clear

▸ _clear(id: string, prefix: string, lastCursor?: undefined | string): Promise‹void›

Defined in Relationship.ts:129

Parameters:

Name | Type | ------ | ------ | id | string | prefix | string | lastCursor? | undefined | string |

Returns: Promise‹void›

_clearValue

▸ _clearValue(value: string, prefix: string, lastCursor?: undefined | string): Promise‹void›

Defined in Relationship.ts:147

Parameters:

Name | Type | ------ | ------ | value | string | prefix | string | lastCursor? | undefined | string |

Returns: Promise‹void›

clear

▸ clear(id: string, prefix: string): Promise‹void›

Defined in Relationship.ts:126

Parameters:

Name | Type | ------ | ------ | id | string | prefix | string |

Returns: Promise‹void›

clearValue

▸ clearValue(value: string, prefix: string): Promise‹void›

Defined in Relationship.ts:144

Parameters:

Name | Type | ------ | ------ | value | string | prefix | string |

Returns: Promise‹void›

get

▸ get(id: string, value: string, prefix: string): Promise‹Relationship‹››

Defined in Relationship.ts:27

Parameters:

Name | Type | ------ | ------ | id | string | value | string | prefix | string |

Returns: Promise‹Relationship‹››

getIdsObjects

▸ getIdsObjects‹T›(schemeOrClass: Schemable | string, value: string, prefix: string, lastKey?: undefined | string): Promise‹[T[], string | undefined]›

Defined in Relationship.ts:85

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | schemeOrClass | Schemable | string | value | string | prefix | string | lastKey? | undefined | string |

Returns: Promise‹[T[], string | undefined]›

getIdsPage

▸ getIdsPage(value: string, prefix: string, lastKey?: undefined | string): Promise‹[string[], string | undefined]›

Defined in Relationship.ts:68

Parameters:

Name | Type | ------ | ------ | value | string | prefix | string | lastKey? | undefined | string |

Returns: Promise‹[string[], string | undefined]›

getObject

▸ getObject‹T›(id: string, prefix: string): Promise‹T›

Defined in Lookup.ts:17

Type parameters:

▪ T

Parameters:

Name | Type | Default | ------ | ------ | ------ | id | string | - | prefix | string | "" |

Returns: Promise‹T›

getUri

▸ getUri(id: string, prefix: string): Promise‹string›

Defined in Lookup.ts:13

Parameters:

Name | Type | Default | ------ | ------ | ------ | id | string | - | prefix | string | "" |

Returns: Promise‹string›

getValuesObjects

▸ getValuesObjects‹T›(schemeOrClass: Schemable | string, id: string, prefix: string, lastKey?: undefined | string): Promise‹[T[], string | undefined]›

Defined in Relationship.ts:48

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | schemeOrClass | Schemable | string | id | string | prefix | string | lastKey? | undefined | string |

Returns: Promise‹[T[], string | undefined]›

getValuesPage

▸ getValuesPage(id: string, prefix: string, lastKey?: undefined | string): Promise‹[string[], string | undefined]›

Defined in Relationship.ts:30

Parameters:

Name | Type | ------ | ------ | id | string | prefix | string | lastKey? | undefined | string |

Returns: Promise‹[string[], string | undefined]›

make

▸ make(payload: object): Promise‹void›

Defined in Event.ts:32

Parameters:

▪ payload: object

Name | Type | ------ | ------ | context? | undefined | object | date? | Date | event | string | uri | string |

Returns: Promise‹void›

makeAddListener

▸ makeAddListener‹T›(scheme: string): (Anonymous function)

Defined in Base.ts:104

Type parameters:

▪ T: Base

Parameters:

Name | Type | ------ | ------ | scheme | string |

Returns: (Anonymous function)

page

▸ page(objectOrId: string | Sessionable, lastKey?: undefined | string): Promise‹[events: Event[], newLastKey: string | undefined]›

Defined in Event.ts:51

Parameters:

Name | Type | ------ | ------ | objectOrId | string | Sessionable | lastKey? | undefined | string |

Returns: Promise‹[events: Event[], newLastKey: string | undefined]›

remove

▸ remove(id: string): Promise‹void›

Defined in Lookup.ts:44

Parameters:

Name | Type | ------ | ------ | id | string |

Returns: Promise‹void›

removeObject

▸ removeObject(object: Sessionable): Promise‹void›

Defined in Lookup.ts:58

Parameters:

Name | Type | ------ | ------ | object | Sessionable |

Returns: Promise‹void›

removeUri

▸ removeUri(uri: string): Promise‹void›

Defined in Lookup.ts:62

Parameters:

Name | Type | ------ | ------ | uri | string |

Returns: Promise‹void›

set

▸ set(id: string, value: string, prefix: string): Promise‹void›

Defined in Relationship.ts:105

Parameters:

Name | Type | ------ | ------ | id | string | value | string | prefix | string |

Returns: Promise‹void›

setCancelRunLater

▸ setCancelRunLater(f: CancelRunLater): void

Defined in Base.ts:28

Parameters:

Name | Type | ------ | ------ | f | CancelRunLater |

Returns: void

setMakeEvent

▸ setMakeEvent(f: MakeEvent): void

Defined in Base.ts:13

Parameters:

Name | Type | ------ | ------ | f | MakeEvent |

Returns: void

setObject

▸ setObject(id: string, object: Sessionable, ttl?: Date): Promise‹void›

Defined in Lookup.ts:22

Parameters:

Name | Type | ------ | ------ | id | string | object | Sessionable | ttl? | Date |

Returns: Promise‹void›

setRunLater

▸ setRunLater(f: RunLater): void

Defined in Base.ts:25

Parameters:

Name | Type | ------ | ------ | f | RunLater |

Returns: void

setUri

▸ setUri(id: string, uri: string, ttl?: Date): Promise‹void›

Defined in Lookup.ts:26

Parameters:

Name | Type | ------ | ------ | id | string | uri | string | ttl? | Date |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › Base

Class: Base

Hierarchy

• Base

  ↳ DDBBase

Implements

• Sessionable

Index

Properties

• id
• scheme
• scheme

Methods

• cancelRunLater
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getUri
• init
• log
• mock
• runLater
• set
• toId
• trigger
• triggerNoLog

Properties

Optional id

• id? : undefined | object

Defined in Base.ts:32

scheme

• scheme: string = ""

Defined in Base.ts:89

Static scheme

▪ scheme: string = ""

Defined in Base.ts:90

Methods

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

Abstract delete

▸ delete(): Promise‹void›

Defined in Base.ts:41

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

Abstract get

▸ get‹T›(key: string, def?: T): Promise‹T›

Defined in Base.ts:36

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

Abstract getAll

▸ getAll‹T›(): Promise‹T›

Defined in Base.ts:37

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Defined in Base.ts:57

Returns: string

getIdObject

▸ getIdObject(): object

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getUri

▸ getUri(): string

Defined in Base.ts:67

Returns: string

init

▸ init(__namedParameters: object): void

Defined in Base.ts:33

Parameters:

▪ __namedParameters: object

Name | Type | ------ | ------ | id | any |

Returns: void

log

▸ log(event: string, context: object): Promise‹void›

Defined in Base.ts:83

Parameters:

Name | Type | Default | ------ | ------ | ------ | event | string | - | context | object | {} |

Returns: Promise‹void›

mock

▸ mock(): object

Defined in Base.ts:64

Returns: object

• [ key: string]: any

runLater

▸ runLater(eventName: string, when: Date, context?: undefined | object): Promise‹void›

Defined in Base.ts:91

Parameters:

Name | Type | ------ | ------ | eventName | string | when | Date | context? | undefined | object |

Returns: Promise‹void›

Abstract set

▸ set(key: string, value: any): Promise‹void›

Defined in Base.ts:40

Parameters:

Name | Type | ------ | ------ | key | string | value | any |

Returns: Promise‹void›

toId

▸ toId(id: string | object): object

Defined in Base.ts:53

Parameters:

Name | Type | ------ | ------ | id | string | object |

Returns: object

• [ key: string]: any

trigger

▸ trigger(eventName: string, data: object): Promise‹void›

Defined in Base.ts:72

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

triggerNoLog

▸ triggerNoLog(eventName: string, data: object): Promise‹void›

Defined in Base.ts:78

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › DDBBase

Class: DDBBase

Hierarchy

• Base

  ↳ DDBBase

  ↳ Event

  ↳ Lookup

  ↳ Relationship

  ↳ Lookupable

Implements

• Sessionable

Index

Properties

• ddb
• id
• scheme
• DDBHandler
• scheme

Methods

• cancelRunLater
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getSync
• getUri
• increment
• init
• load
• loadFromItem
• log
• mock
• remove
• runLater
• set
• toId
• trigger
• triggerNoLog

Properties

ddb

• ddb: DDBHandler

Defined in DDBBase.ts:4

Optional id

• id? : undefined | object

Inherited from Base.id

Defined in Base.ts:32

scheme

• scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:89

Static DDBHandler

▪ DDBHandler: DDBHandler = DDBHandler

Defined in DDBBase.ts:98

Static scheme

▪ scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:90

Methods

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Inherited from Base.cancelRunLater

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

delete

▸ delete(): Promise‹void›

Overrides Base.delete

Defined in DDBBase.ts:95

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Inherited from Base.exists

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

get

▸ get‹T›(key: string, def?: T): Promise‹T›

Overrides Base.get

Defined in DDBBase.ts:30

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

getAll

▸ getAll‹T›(): Promise‹T›

Overrides Base.getAll

Defined in DDBBase.ts:66

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Inherited from Base.getId

Defined in Base.ts:57

Returns: string

getIdObject

▸ getIdObject(): object

Inherited from Base.getIdObject

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Inherited from Base.getOptional

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getSync

▸ getSync‹T›(key: string, def?: T): T

Defined in DDBBase.ts:71

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: T

getUri

▸ getUri(): string

Inherited from Base.getUri

Defined in Base.ts:67

Returns: string

increment

▸ increment(key: string, byValue: number): Promise‹void›

Defined in DDBBase.ts:89

Parameters:

Name | Type | Default | ------ | ------ | ------ | key | string | - | byValue | number | 1 |

Returns: Promise‹void›

init

▸ init(__namedParameters: object): void

Overrides Base.init

Defined in DDBBase.ts:5

Parameters:

▪ __namedParameters: object

Name | Type | Default | ------ | ------ | ------ | id | undefined | string | object | - | partitionKey | string | "id" | tableName | string | - |

Returns: void

load

▸ load(): Promise‹this›

Defined in DDBBase.ts:17

Returns: Promise‹this›

loadFromItem

▸ loadFromItem(Item: object): Promise‹this›

Defined in DDBBase.ts:24

Parameters:

Name | Type | ------ | ------ | Item | object |

Returns: Promise‹this›

log

▸ log(event: string, context: object): Promise‹void›

Inherited from Base.log

Defined in Base.ts:83

Parameters:

Name | Type | Default | ------ | ------ | ------ | event | string | - | context | object | {} |

Returns: Promise‹void›

mock

▸ mock(): object

Inherited from Base.mock

Defined in Base.ts:64

Returns: object

• [ key: string]: any

remove

▸ remove(key: string): Promise‹void›

Defined in DDBBase.ts:92

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹void›

runLater

▸ runLater(eventName: string, when: Date, context?: undefined | object): Promise‹void›

Inherited from Base.runLater

Defined in Base.ts:91

Parameters:

Name | Type | ------ | ------ | eventName | string | when | Date | context? | undefined | object |

Returns: Promise‹void›

set

▸ set(key: string | object, value?: any): Promise‹void›

Overrides Base.set

Defined in DDBBase.ts:79

Parameters:

Name | Type | ------ | ------ | key | string | object | value? | any |

Returns: Promise‹void›

toId

▸ toId(id: string | object): object

Inherited from Base.toId

Defined in Base.ts:53

Parameters:

Name | Type | ------ | ------ | id | string | object |

Returns: object

• [ key: string]: any

trigger

▸ trigger(eventName: string, data: object): Promise‹void›

Inherited from Base.trigger

Defined in Base.ts:72

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

triggerNoLog

▸ triggerNoLog(eventName: string, data: object): Promise‹void›

Inherited from Base.triggerNoLog

Defined in Base.ts:78

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › Event

Class: Event

Hierarchy

↳ DDBBase

↳ Event

Implements

• Sessionable

Index

Constructors

• constructor

Properties

• ddb
• id
• scheme
• DDBHandler
• scheme

Methods

• cancelRunLater
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getSync
• getUri
• increment
• init
• load
• loadFromItem
• log
• mock
• remove
• runLater
• set
• toId
• trigger
• triggerNoLog

Constructors

constructor

+ new Event(uri?: undefined | string, date?: undefined | string): Event

Defined in Event.ts:7

Parameters:

Name | Type | ------ | ------ | uri? | undefined | string | date? | undefined | string |

Returns: Event

Properties

ddb

• ddb: DDBHandler

Inherited from DDBBase.ddb

Defined in DDBBase.ts:4

Optional id

• id? : undefined | object

Inherited from Base.id

Defined in Base.ts:32

scheme

• scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:89

Static DDBHandler

▪ DDBHandler: DDBHandler = DDBHandler

Inherited from DDBBase.DDBHandler

Defined in DDBBase.ts:98

Static scheme

▪ scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:90

Methods

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Inherited from Base.cancelRunLater

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

delete

▸ delete(): Promise‹void›

Inherited from DDBBase.delete

Overrides Base.delete

Defined in DDBBase.ts:95

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Inherited from Base.exists

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

get

▸ get‹T›(key: string, def?: T): Promise‹T›

Inherited from DDBBase.get

Overrides Base.get

Defined in DDBBase.ts:30

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

getAll

▸ getAll‹T›(): Promise‹T›

Inherited from DDBBase.getAll

Overrides Base.getAll

Defined in DDBBase.ts:66

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Overrides Base.getId

Defined in Event.ts:23

Returns: string

getIdObject

▸ getIdObject(): object

Inherited from Base.getIdObject

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Inherited from Base.getOptional

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getSync

▸ getSync‹T›(key: string, def?: T): T

Inherited from DDBBase.getSync

Defined in DDBBase.ts:71

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: T

getUri

▸ getUri(): string

Inherited from Base.getUri

Defined in Base.ts:67

Returns: string

increment

▸ increment(key: string, byValue: number): Promise‹void›

Inherited from DDBBase.increment

Defined in DDBBase.ts:89

Parameters:

Name | Type | Default | ------ | ------ | ------ | key | string | - | byValue | number | 1 |

Returns: Promise‹void›

init

▸ init(__namedParameters: object): void

Inherited from DDBBase.init

Overrides Base.init

Defined in DDBBase.ts:5

Parameters:

▪ __namedParameters: object

Name | Type | Default | ------ | ------ | ------ | id | undefined | string | object | - | partitionKey | string | "id" | tableName | string | - |

Returns: void

load

▸ load(): Promise‹this›

Inherited from DDBBase.load

Defined in DDBBase.ts:17

Returns: Promise‹this›

loadFromItem

▸ loadFromItem(Item: object): Promise‹this›

Inherited from DDBBase.loadFromItem

Defined in DDBBase.ts:24

Parameters:

Name | Type | ------ | ------ | Item | object |

Returns: Promise‹this›

log

▸ log(event: string, context: object): Promise‹void›

Overrides Base.log

Defined in Event.ts:27

Parameters:

Name | Type | Default | ------ | ------ | ------ | event | string | - | context | object | {} |

Returns: Promise‹void›

mock

▸ mock(): object

Inherited from Base.mock

Defined in Base.ts:64

Returns: object

• [ key: string]: any

remove

▸ remove(key: string): Promise‹void›

Inherited from DDBBase.remove

Defined in DDBBase.ts:92

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹void›

runLater

▸ runLater(eventName: string, when: Date, context?: undefined | object): Promise‹void›

Inherited from Base.runLater

Defined in Base.ts:91

Parameters:

Name | Type | ------ | ------ | eventName | string | when | Date | context? | undefined | object |

Returns: Promise‹void›

set

▸ set(key: string | object, value?: any): Promise‹void›

Inherited from DDBBase.set

Overrides Base.set

Defined in DDBBase.ts:79

Parameters:

Name | Type | ------ | ------ | key | string | object | value? | any |

Returns: Promise‹void›

toId

▸ toId(id: string | object): object | object

Overrides Base.toId

Defined in Event.ts:16

Parameters:

Name | Type | ------ | ------ | id | string | object |

Returns: object | object

trigger

▸ trigger(eventName: string, data: object): Promise‹void›

Inherited from Base.trigger

Defined in Base.ts:72

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

triggerNoLog

▸ triggerNoLog(eventName: string, data: object): Promise‹void›

Inherited from Base.triggerNoLog

Defined in Base.ts:78

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › Lookup

Class: Lookup

Hierarchy

↳ DDBBase

↳ Lookup

Implements

• Sessionable

Index

Constructors

• constructor

Properties

• ddb
• id
• scheme
• DDBHandler
• scheme

Methods

• cancelRunLater
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getSync
• getUri
• increment
• init
• load
• loadFromItem
• log
• mock
• remove
• runLater
• set
• toId
• trigger
• triggerNoLog

Constructors

constructor

+ new Lookup(id?: undefined | string): Lookup

Defined in Lookup.ts:4

Parameters:

Name | Type | ------ | ------ | id? | undefined | string |

Returns: Lookup

Properties

ddb

• ddb: DDBHandler

Inherited from DDBBase.ddb

Defined in DDBBase.ts:4

Optional id

• id? : undefined | object

Inherited from Base.id

Defined in Base.ts:32

scheme

• scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:89

Static DDBHandler

▪ DDBHandler: DDBHandler = DDBHandler

Inherited from DDBBase.DDBHandler

Defined in DDBBase.ts:98

Static scheme

▪ scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:90

Methods

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Inherited from Base.cancelRunLater

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

delete

▸ delete(): Promise‹void›

Inherited from DDBBase.delete

Overrides Base.delete

Defined in DDBBase.ts:95

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Inherited from Base.exists

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

get

▸ get‹T›(key: string, def?: T): Promise‹T›

Inherited from DDBBase.get

Overrides Base.get

Defined in DDBBase.ts:30

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

getAll

▸ getAll‹T›(): Promise‹T›

Inherited from DDBBase.getAll

Overrides Base.getAll

Defined in DDBBase.ts:66

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Inherited from Base.getId

Defined in Base.ts:57

Returns: string

getIdObject

▸ getIdObject(): object

Inherited from Base.getIdObject

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Inherited from Base.getOptional

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getSync

▸ getSync‹T›(key: string, def?: T): T

Inherited from DDBBase.getSync

Defined in DDBBase.ts:71

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: T

getUri

▸ getUri(): string

Inherited from Base.getUri

Defined in Base.ts:67

Returns: string

increment

▸ increment(key: string, byValue: number): Promise‹void›

Inherited from DDBBase.increment

Defined in DDBBase.ts:89

Parameters:

Name | Type | Default | ------ | ------ | ------ | key | string | - | byValue | number | 1 |

Returns: Promise‹void›

init

▸ init(__namedParameters: object): void

Inherited from DDBBase.init

Overrides Base.init

Defined in DDBBase.ts:5

Parameters:

▪ __namedParameters: object

Name | Type | Default | ------ | ------ | ------ | id | undefined | string | object | - | partitionKey | string | "id" | tableName | string | - |

Returns: void

load

▸ load(): Promise‹this›

Inherited from DDBBase.load

Defined in DDBBase.ts:17

Returns: Promise‹this›

loadFromItem

▸ loadFromItem(Item: object): Promise‹this›

Inherited from DDBBase.loadFromItem

Defined in DDBBase.ts:24

Parameters:

Name | Type | ------ | ------ | Item | object |

Returns: Promise‹this›

log

▸ log(event: string, context: object): Promise‹void›

Inherited from Base.log

Defined in Base.ts:83

Parameters:

Name | Type | Default | ------ | ------ | ------ | event | string | - | context | object | {} |

Returns: Promise‹void›

mock

▸ mock(): object

Inherited from Base.mock

Defined in Base.ts:64

Returns: object

• [ key: string]: any

remove

▸ remove(key: string): Promise‹void›

Inherited from DDBBase.remove

Defined in DDBBase.ts:92

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹void›

runLater

▸ runLater(eventName: string, when: Date, context?: undefined | object): Promise‹void›

Inherited from Base.runLater

Defined in Base.ts:91

Parameters:

Name | Type | ------ | ------ | eventName | string | when | Date | context? | undefined | object |

Returns: Promise‹void›

set

▸ set(key: string | object, value?: any): Promise‹void›

Inherited from DDBBase.set

Overrides Base.set

Defined in DDBBase.ts:79

Parameters:

Name | Type | ------ | ------ | key | string | object | value? | any |

Returns: Promise‹void›

toId

▸ toId(id: string | object): object

Inherited from Base.toId

Defined in Base.ts:53

Parameters:

Name | Type | ------ | ------ | id | string | object |

Returns: object

• [ key: string]: any

trigger

▸ trigger(eventName: string, data: object): Promise‹void›

Inherited from Base.trigger

Defined in Base.ts:72

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

triggerNoLog

▸ triggerNoLog(eventName: string, data: object): Promise‹void›

Inherited from Base.triggerNoLog

Defined in Base.ts:78

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › Lookupable

Class: Lookupable

Hierarchy

↳ DDBBase

↳ Lookupable

Implements

• Sessionable

Index

Properties

• ddb
• id
• scheme
• DDBHandler
• scheme

Methods

• addRelationship
• cancelRunLater
• clearLookups
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getSync
• getUri
• increment
• init
• load
• loadFromItem
• log
• mock
• remove
• removeLookup
• removeRelationship
• removeValueRelationship
• runLater
• set
• setLookup
• toId
• trigger
• triggerNoLog

Properties

ddb

• ddb: DDBHandler

Inherited from DDBBase.ddb

Defined in DDBBase.ts:4

Optional id

• id? : undefined | object

Inherited from Base.id

Defined in Base.ts:32

scheme

• scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:89

Static DDBHandler

▪ DDBHandler: DDBHandler = DDBHandler

Inherited from DDBBase.DDBHandler

Defined in DDBBase.ts:98

Static scheme

▪ scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:90

Methods

addRelationship

▸ addRelationship(valueOrObject: String | Base, prefix: string): Promise‹void›

Defined in Lookupable.ts:24

Parameters:

Name | Type | ------ | ------ | valueOrObject | String | Base | prefix | string |

Returns: Promise‹void›

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Inherited from Base.cancelRunLater

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

clearLookups

▸ clearLookups(prefix?: undefined | string): Promise‹void›

Defined in Lookupable.ts:21

Parameters:

Name | Type | ------ | ------ | prefix? | undefined | string |

Returns: Promise‹void›

delete

▸ delete(): Promise‹void›

Inherited from DDBBase.delete

Overrides Base.delete

Defined in DDBBase.ts:95

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Inherited from Base.exists

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

get

▸ get‹T›(key: string, def?: T): Promise‹T›

Inherited from DDBBase.get

Overrides Base.get

Defined in DDBBase.ts:30

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

getAll

▸ getAll‹T›(): Promise‹T›

Inherited from DDBBase.getAll

Overrides Base.getAll

Defined in DDBBase.ts:66

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Inherited from Base.getId

Defined in Base.ts:57

Returns: string

getIdObject

▸ getIdObject(): object

Inherited from Base.getIdObject

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Inherited from Base.getOptional

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getSync

▸ getSync‹T›(key: string, def?: T): T

Inherited from DDBBase.getSync

Defined in DDBBase.ts:71

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: T

getUri

▸ getUri(): string

Inherited from Base.getUri

Defined in Base.ts:67

Returns: string

increment

▸ increment(key: string, byValue: number): Promise‹void›

Inherited from DDBBase.increment

Defined in DDBBase.ts:89

Parameters:

Name | Type | Default | ------ | ------ | ------ | key | string | - | byValue | number | 1 |

Returns: Promise‹void›

init

▸ init(__namedParameters: object): void

Inherited from DDBBase.init

Overrides Base.init

Defined in DDBBase.ts:5

Parameters:

▪ __namedParameters: object

Name | Type | Default | ------ | ------ | ------ | id | undefined | string | object | - | partitionKey | string | "id" | tableName | string | - |

Returns: void

load

▸ load(): Promise‹this›

Inherited from DDBBase.load

Defined in DDBBase.ts:17

Returns: Promise‹this›

loadFromItem

▸ loadFromItem(Item: object): Promise‹this›

Inherited from DDBBase.loadFromItem

Defined in DDBBase.ts:24

Parameters:

Name | Type | ------ | ------ | Item | object |

Returns: Promise‹this›

log

▸ log(event: string, context: object): Promise‹void›

Inherited from Base.log

Defined in Base.ts:83

Parameters:

Name | Type | Default | ------ | ------ | ------ | event | string | - | context | object | {} |

Returns: Promise‹void›

mock

▸ mock(): object

Inherited from Base.mock

Defined in Base.ts:64

Returns: object

• [ key: string]: any

remove

▸ remove(key: string): Promise‹void›

Inherited from DDBBase.remove

Defined in DDBBase.ts:92

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹void›

removeLookup

▸ removeLookup(value: string, prefix: string): Promise‹void›

Defined in Lookupable.ts:13

Parameters:

Name | Type | ------ | ------ | value | string | prefix | string |

Returns: Promise‹void›

removeRelationship

▸ removeRelationship(valueOrObject: String | Base, prefix: string): Promise‹void›

Defined in Lookupable.ts:31

Parameters:

Name | Type | ------ | ------ | valueOrObject | String | Base | prefix | string |

Returns: Promise‹void›

removeValueRelationship

▸ removeValueRelationship(idOrObject: String | Base, prefix: string): Promise‹void›

Defined in Lookupable.ts:38

Parameters:

Name | Type | ------ | ------ | idOrObject | String | Base | prefix | string |

Returns: Promise‹void›

runLater

▸ runLater(eventName: string, when: Date, context?: undefined | object): Promise‹void›

Inherited from Base.runLater

Defined in Base.ts:91

Parameters:

Name | Type | ------ | ------ | eventName | string | when | Date | context? | undefined | object |

Returns: Promise‹void›

set

▸ set(key: string | object, value?: any): Promise‹void›

Inherited from DDBBase.set

Overrides Base.set

Defined in DDBBase.ts:79

Parameters:

Name | Type | ------ | ------ | key | string | object | value? | any |

Returns: Promise‹void›

setLookup

▸ setLookup(value: string, prefix: string, ttl?: Date): Promise‹void›

Defined in Lookupable.ts:10

Parameters:

Name | Type | ------ | ------ | value | string | prefix | string | ttl? | Date |

Returns: Promise‹void›

toId

▸ toId(id: string | object): object

Inherited from Base.toId

Defined in Base.ts:53

Parameters:

Name | Type | ------ | ------ | id | string | object |

Returns: object

• [ key: string]: any

trigger

▸ trigger(eventName: string, data: object): Promise‹void›

Inherited from Base.trigger

Defined in Base.ts:72

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

triggerNoLog

▸ triggerNoLog(eventName: string, data: object): Promise‹void›

Inherited from Base.triggerNoLog

Defined in Base.ts:78

Parameters:

Name | Type | Default | ------ | ------ | ------ | eventName | string | - | data | object | {} |

Returns: Promise‹void›

@raydeck/controller-manager - v1.13.0 › Relationship

Class: Relationship

Hierarchy

↳ DDBBase

↳ Relationship

Implements

• Sessionable

Index

Constructors

• constructor

Properties

• ddb
• id
• scheme
• DDBHandler
• scheme

Methods

• cancelRunLater
• delete
• exists
• get
• getAll
• getId
• getIdObject
• getOptional
• getSync
• getUri
• increment
• init
• load
• loadFromItem
• log
• mock
• remove
• runLater
• set
• toId
• trigger
• triggerNoLog

Constructors

constructor

+ new Relationship(id?: undefined | string): Relationship

Defined in Relationship.ts:6

Parameters:

Name | Type | ------ | ------ | id? | undefined | string |

Returns: Relationship

Properties

ddb

• ddb: DDBHandler

Inherited from DDBBase.ddb

Defined in DDBBase.ts:4

Optional id

• id? : undefined | object

Inherited from Base.id

Defined in Base.ts:32

scheme

• scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:89

Static DDBHandler

▪ DDBHandler: DDBHandler = DDBHandler

Inherited from DDBBase.DDBHandler

Defined in DDBBase.ts:98

Static scheme

▪ scheme: string = ""

Inherited from Base.scheme

Defined in Base.ts:90

Methods

cancelRunLater

▸ cancelRunLater(eventName: string): Promise‹void›

Inherited from Base.cancelRunLater

Defined in Base.ts:99

Parameters:

Name | Type | ------ | ------ | eventName | string |

Returns: Promise‹void›

delete

▸ delete(): Promise‹void›

Inherited from DDBBase.delete

Overrides Base.delete

Defined in DDBBase.ts:95

Returns: Promise‹void›

exists

▸ exists(key: string): Promise‹boolean›

Inherited from Base.exists

Defined in Base.ts:45

Parameters:

Name | Type | ------ | ------ | key | string |

Returns: Promise‹boolean›

get

▸ get‹T›(key: string, def?: T): Promise‹T›

Inherited from DDBBase.get

Overrides Base.get

Defined in DDBBase.ts:30

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T›

getAll

▸ getAll‹T›(): Promise‹T›

Inherited from DDBBase.getAll

Overrides Base.getAll

Defined in DDBBase.ts:66

Type parameters:

▪ T: object

Returns: Promise‹T›

getId

▸ getId(): string

Overrides Base.getId

Defined in Relationship.ts:22

Returns: string

getIdObject

▸ getIdObject(): object

Inherited from Base.getIdObject

Defined in Base.ts:60

Returns: object

• [ key: string]: any

getOptional

▸ getOptional‹T›(key: string, def?: T): Promise‹T | undefined›

Inherited from Base.getOptional

Defined in Base.ts:42

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: Promise‹T | undefined›

getSync

▸ getSync‹T›(key: string, def?: T): T

Inherited from DDBBase.getSync

Defined in DDBBase.ts:71

Type parameters:

▪ T

Parameters:

Name | Type | ------ | ------ | key | string | def? | T |

Returns: T

getUri

▸ getUri(): string

Inherited from Base.getUri

Defined in Base.ts:67

Returns: string

increment

▸ increment(key: string, byValue: number): Promise‹void›

Inherited from DDBBase.increment

*Defined in [DDBBase.ts:89](https://gith