@decaf-ts/for-couchdb/lib/esm/model/CouchDBSequence.d.ts

template for ts projects

import type { ModelArg } from "@decaf-ts/decorator-validation";
import { BaseModel } from "@decaf-ts/core";
/**
 * @description Model for CouchDB sequence records
 * @summary Represents a sequence in CouchDB used for generating sequential IDs
 * @param {ModelArg<Sequence>} [seq] - Optional initialization data for the sequence
 * @class
 * @example
 * // Example of creating and using a Sequence
 * const sequence = new Sequence({ id: 'user-seq', current: 1 });
 * // Increment the sequence
 * sequence.current = Number(sequence.current) + 1;
 */
export declare class Sequence extends BaseModel {
    /**
     * @description The unique identifier for the sequence
     * @summary Primary key for the sequence record
     */
    id: string;
    /**
     * @description The current value of the sequence
     * @summary Current sequence value that can be incremented
     */
    current: string | number;
    constructor(seq?: ModelArg<Sequence>);
}