Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentType<T>

A node represented by its own full Schema. Marshalled as an embedded map.

Type parameters

  • T

Hierarchy

Index

Properties

Optional attributeName

attributeName: undefined | string

The key in which this value will be persisted in DynamoDB. If not provided, the key will be assumed to be the same in the input and in the persisted record.

Optional defaultProvider

defaultProvider: undefined | function

An optional default value factory. If a type has a defined defaultProvider and its value is undefined in the provided input, the defaultProvider will be called and its return value serialized.

members

members: Schema

A Schema outlining how the members of this document are to be (un)marshalled.

type

type: "Document"

Optional valueConstructor

valueConstructor: ZeroArgumentsConstructor<T>

A constructor to invoke to create an object onto which the document's members will be unmarshalled. If not provided, Object.create(null) will be used.