data-cap
    Preparing search index...

    Interface LifecycleModelField

    One field's declared lifecycle data. Only fields with at least one of these set appear in the model at all.

    interface LifecycleModelField {
        deprecated: boolean | undefined;
        deprecatedReason: string | undefined;
        expiresAt: string | undefined;
        path: readonly string[];
        removeBy: string | undefined;
        renamedFrom: string | undefined;
        retention: string | undefined;
    }
    Index
    deprecated deprecatedReason expiresAt path removeBy renamedFrom retention
    deprecated: boolean | undefined

    Whether the field is documented as deprecated.

    deprecatedReason: string | undefined

    Why it's deprecated, when stated.

    expiresAt: string | undefined

    Declared ISO-8601 expiry, unparsed and uninterpreted here.

    path: readonly string[]

    The field's path within its capability -- readonly string[], matching every other model's field addressing (never a flat key string).

    removeBy: string | undefined

    Declared ISO-8601 removal deadline -- field-level only (see core/document.ts).

    renamedFrom: string | undefined

    The field's previous name, when authored -- what ChangeModel.renamedFields correlates against.

    retention: string | undefined

    Declared retention policy -- a policy statement, deliberately independent of expiresAt's temporal constraint (a field can be retained long after its source credential expires, and vice versa).

    Settings
    Member Visibility

    On This Page
    Properties