Type Alias GetItemOutput<C, ET, A>

GetItemOutput: Omit<GetCommandOutput, "Item"> & {
    Item?: A extends readonly string[]
        ? number extends A["length"]
            ? EntityRecord<C, ET>
            : EntityRecordPartial<C, ET, A>
        : EntityRecord<C, ET>;
}

Return type helper for EntityClient.getItem.

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

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, Item is narrowed to the projected shape; otherwise it falls back to the full storage record shape.

Type Declaration

OptionalItem?: A extends readonly string[]
    ? number extends A["length"]
        ? EntityRecord<C, ET>
        : EntityRecordPartial<C, ET, A>
    : EntityRecord<C, ET>
Returned item (storage record); undefined when not found.