Type alias CollectionKeyOptions

CollectionKeyOptions: {
    allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}

An object defining the collection's key generation.

Type declaration

  • Optional allowUserKeys?: boolean

    Unless set to false, documents can be created with a user-specified _key attribute.

    Default: true

  • Optional increment?: number

    (Autoincrement only.) How many steps to increment the key each time.

  • Optional offset?: number

    (Autoincrement only.) Initial offset for the key.

  • Optional type?: KeyGenerator

    Type of key generator to use.

Generated using TypeDoc