@karmaniverous/entity-client-dynamodb
    Preparing search index...

    Interface GetItemsOutput<C, ET, A>

    Return type helper for EntityClient.getItems.

    TypeDoc requires this to be exported when it appears in an exported method signature.

    interface GetItemsOutput<
        C extends BaseConfigMap,
        ET extends EntityToken<C>,
        A extends readonly string[] | undefined,
    > {
        items: (
            A extends readonly string[]
                ? number extends A<A>["length"]
                    ? EntityRecord<C, ET>
                    : EntityRecordPartial<C, ET, A<A>>
                : EntityRecord<C, ET>
        )[];
        outputs: BatchGetCommandOutput[];
    }

    Type Parameters

    • C extends BaseConfigMap

      Entity-manager config map.

    • ET extends EntityToken<C>

      Entity token.

    • A extends readonly string[] | undefined

      Optional projection tuple. If a const tuple is provided, items are narrowed to the projected shape; otherwise they fall back to full storage record shapes.

    Index

    Properties

    items outputs

    Properties

    items: (
        A extends readonly string[]
            ? number extends A<A>["length"]
                ? EntityRecord<C, ET>
                : EntityRecordPartial<C, ET, A<A>>
            : EntityRecord<C, ET>
    )[]

    Items returned from DynamoDB, typed by token and projection tuple.

    outputs: BatchGetCommandOutput[]

    Raw batch outputs (including retries).

    Settings

    Member Visibility

    On This Page

    Properties