Interface ICollectionSpec

Provides options for configuring a collection.

interface ICollectionSpec {
    history?: boolean;
    maxExpiry?: number;
    name: string;
    scopeName: string;
}

Properties

history? maxExpiry? name scopeName

Properties

Optional history

history?: boolean

The history retention override setting in this collection. Only supported on Magma Buckets.

See

StorageBackend.Magma.

Optional maxExpiry

maxExpiry?: number

The maximum expiry for documents in this collection.

See

IBucketSettings.maxExpiry

name

name: string

The name of the collection.

scopeName

scopeName: string

The name of the scope containing this collection.

Settings

Member Visibility

Theme

On This Page

historymaxExpirynamescopeName