DynamoEntity
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DynamoEntity<Schema>(config): DynamoEntity<Schema>;Parameters
Section titled “Parameters”config
Section titled “config”DynamoEntityConfig<Schema>
Returns
Section titled “Returns”DynamoEntity<Schema>
Accessors
Section titled “Accessors”schema
Section titled “schema”Get Signature
Section titled “Get Signature”get schema(): Schema;Returns
Section titled “Returns”Schema
secondaryIndexKeyBuilders
Section titled “secondaryIndexKeyBuilders”Get Signature
Section titled “Get Signature”get secondaryIndexKeyBuilders(): object;Returns
Section titled “Returns”object
gsi: GlobalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;lsi: LocalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;Get Signature
Section titled “Get Signature”get table(): DynamoTable;Returns
Section titled “Returns”Methods
Section titled “Methods”buildAllKeys()
Section titled “buildAllKeys()”buildAllKeys(item): DynamoKey;Parameters
Section titled “Parameters”Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”buildGlobalSecondaryIndexKey()
Section titled “buildGlobalSecondaryIndexKey()”buildGlobalSecondaryIndexKey(indexName, item): DynamoIndexKey;Parameters
Section titled “Parameters”indexName
Section titled “indexName”string
Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”buildLocalSecondaryIndexKey()
Section titled “buildLocalSecondaryIndexKey()”buildLocalSecondaryIndexKey(indexName, item): DynamoIndexKey;Parameters
Section titled “Parameters”indexName
Section titled “indexName”string
Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”buildPartitionKey()
Section titled “buildPartitionKey()”buildPartitionKey(item): | DynamoKeyableValue | undefined;Parameters
Section titled “Parameters”Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”| DynamoKeyableValue
| undefined
buildPrimaryKey()
Section titled “buildPrimaryKey()”buildPrimaryKey(item): DynamoKey;Parameters
Section titled “Parameters”Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”buildPrimaryOrIndexKey()
Section titled “buildPrimaryOrIndexKey()”buildPrimaryOrIndexKey(keyInput): | DynamoKey | DynamoIndexKey;Parameters
Section titled “Parameters”keyInput
Section titled “keyInput”EntityKeyInput<EntitySchema<Schema>>
Returns
Section titled “Returns”buildSortKey()
Section titled “buildSortKey()”buildSortKey(item): | DynamoKeyableValue | undefined;Parameters
Section titled “Parameters”Partial<EntitySchema<Schema>>
Returns
Section titled “Returns”| DynamoKeyableValue
| undefined
paginate()
Section titled “paginate()”paginate<CommandOutput>(paginatable): AsyncGenerator<CommandOutput, void, unknown>;Type Parameters
Section titled “Type Parameters”CommandOutput
Section titled “CommandOutput”CommandOutput
Parameters
Section titled “Parameters”paginatable
Section titled “paginatable”BasePaginatable<CommandOutput, Schema>
Returns
Section titled “Returns”AsyncGenerator<CommandOutput, void, unknown>
send()
Section titled “send()”send<CommandOutput>(command): Promise<CommandOutput>;Type Parameters
Section titled “Type Parameters”CommandOutput
Section titled “CommandOutput”CommandOutput
Parameters
Section titled “Parameters”command
Section titled “command”BaseCommand<CommandOutput, Schema>
Returns
Section titled “Returns”Promise<CommandOutput>