Interface ClientModel<Bag, Metadata, IsRDS, T, K>

interface ClientModel<Bag, Metadata, IsRDS, T, K> {
    __entityType: "model";
    __meta: {
        disabledOperations: DisabledOpsToMap<T["disabledOperations"]>;
        listOptionsPkParams: ListOptionsPkParams<Bag, T>;
    };
    createType: Prettify<CreateModelInput<ClientModel<Bag, Metadata, IsRDS, T, K>>>;
    deleteType: Prettify<ResolveIdentifierFields<ShallowPretty<{
        [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
            ? K
            : never]: ResolveIndividualField<Bag, T["fields"][K]>
    } & {
        [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
            ? never
            : K]?: ResolveIndividualField<Bag, T["fields"][K]>
    }>, T["identifier"]["pk"] & (T["identifier"]["sk"] extends never
        ? unknown
        : T["identifier"]["sk"])>>;
    identifier: KindaPretty<ResolveIdentifierFields<ShallowPretty<{
        [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
            ? K
            : never]: ResolveIndividualField<Bag, T["fields"][K]>
    } & {
        [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
            ? never
            : K]?: ResolveIndividualField<Bag, T["fields"][K]>
    }>, T["identifier"]["pk"] & (T["identifier"]["sk"] extends never
        ? unknown
        : T["identifier"]["sk"])>>;
    nestedTypes: NestedTypes<ClientFields<Bag, Metadata, IsRDS, T>, T>;
    secondaryIndexes: IndexQueryMethodsFromIR<Bag, T["secondaryIndexes"], K, unknown>;
    type: KindaPretty<ClientFields<Bag, Metadata, IsRDS, T>>;
    updateType: Prettify<UpdateModelInput<ClientModel<Bag, Metadata, IsRDS, T, K>>>;
}

Type Parameters

Hierarchy (view full)

Properties

__entityType __meta createType deleteType identifier nestedTypes secondaryIndexes type updateType

Properties

__entityType

__entityType: "model"

__meta

__meta: {
    disabledOperations: DisabledOpsToMap<T["disabledOperations"]>;
    listOptionsPkParams: ListOptionsPkParams<Bag, T>;
}

Type declaration

createType

createType: Prettify<CreateModelInput<ClientModel<Bag, Metadata, IsRDS, T, K>>>

deleteType

deleteType: Prettify<ResolveIdentifierFields<ShallowPretty<{
    [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
        ? K
        : never]: ResolveIndividualField<Bag, T["fields"][K]>
} & {
    [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
        ? never
        : K]?: ResolveIndividualField<Bag, T["fields"][K]>
}>, T["identifier"]["pk"] & (T["identifier"]["sk"] extends never
    ? unknown
    : T["identifier"]["sk"])>>

identifier

identifier: KindaPretty<ResolveIdentifierFields<ShallowPretty<{
    [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
        ? K
        : never]: ResolveIndividualField<Bag, T["fields"][K]>
} & {
    [K in string | number | symbol as IsRequired<T["fields"][K]> extends true
        ? never
        : K]?: ResolveIndividualField<Bag, T["fields"][K]>
}>, T["identifier"]["pk"] & (T["identifier"]["sk"] extends never
    ? unknown
    : T["identifier"]["sk"])>>

nestedTypes

nestedTypes: NestedTypes<ClientFields<Bag, Metadata, IsRDS, T>, T>

secondaryIndexes

secondaryIndexes: IndexQueryMethodsFromIR<Bag, T["secondaryIndexes"], K, unknown>

type

type: KindaPretty<ClientFields<Bag, Metadata, IsRDS, T>>

updateType

updateType: Prettify<UpdateModelInput<ClientModel<Bag, Metadata, IsRDS, T, K>>>

Settings

Member Visibility

Theme

On This Page