@backland/schema/lib/fields/CursorField.d.ts

TypeScript schema declaration and validation library with static type inference

import type { ObjectType } from '../ObjectType';
import { FieldType, FieldTypeParser } from './FieldType';
import { CursorType } from './_fieldDefinitions';
declare const def: {
    readonly PK: {
        readonly description: "Primary Key";
        readonly string: {};
    };
    readonly SK: {
        readonly description: "Secondary or Sort Key";
        readonly optional: true;
        readonly string: {};
    };
    readonly after: {
        readonly optional: true;
        readonly string: {};
    };
    readonly fields: {
        readonly list: true;
        readonly optional: true;
        readonly string: {};
    };
    readonly limit: {
        readonly int: {};
        readonly optional: true;
    };
    readonly prefix: {
        readonly description: "The prefix to search as \"startsWith\" in SK";
        readonly optional: true;
        readonly string: {};
    };
    readonly sep: {
        readonly description: "Composite key separator";
        readonly optional: true;
        readonly string: {};
    };
    readonly version: {
        readonly description: "The Cursor format version";
        readonly string: {};
    };
};
type CursorDef = typeof def;
export declare class CursorField extends FieldType<CursorType, 'cursor', undefined> {
    parse: FieldTypeParser<CursorType>;
    utils: {
        object: ObjectType<CursorDef>;
    };
    static object(): ObjectType<{
        readonly PK: {
            readonly description: "Primary Key";
            readonly string: {};
        };
        readonly SK: {
            readonly description: "Secondary or Sort Key";
            readonly optional: true;
            readonly string: {};
        };
        readonly after: {
            readonly optional: true;
            readonly string: {};
        };
        readonly fields: {
            readonly list: true;
            readonly optional: true;
            readonly string: {};
        };
        readonly limit: {
            readonly int: {};
            readonly optional: true;
        };
        readonly prefix: {
            readonly description: "The prefix to search as \"startsWith\" in SK";
            readonly optional: true;
            readonly string: {};
        };
        readonly sep: {
            readonly description: "Composite key separator";
            readonly optional: true;
            readonly string: {};
        };
        readonly version: {
            readonly description: "The Cursor format version";
            readonly string: {};
        };
    }, {
        readonly PK: {
            readonly description: "Primary Key";
            readonly string: {};
        };
        readonly SK: {
            readonly description: "Secondary or Sort Key";
            readonly optional: true;
            readonly string: {};
        };
        readonly after: {
            readonly optional: true;
            readonly string: {};
        };
        readonly fields: {
            readonly list: true;
            readonly optional: true;
            readonly string: {};
        };
        readonly limit: {
            readonly int: {};
            readonly optional: true;
        };
        readonly prefix: {
            readonly description: "The prefix to search as \"startsWith\" in SK";
            readonly optional: true;
            readonly string: {};
        };
        readonly sep: {
            readonly description: "Composite key separator";
            readonly optional: true;
            readonly string: {};
        };
        readonly version: {
            readonly description: "The Cursor format version";
            readonly string: {};
        };
    }>;
    constructor();
    static create: () => CursorField;
}
export {};