Nymph.js 1.0.0-beta.113
    Preparing search index...

    Type Alias Options<T>

    type Options<T extends EntityConstructor = EntityConstructor> = {
        acRequest?: TilmeldAccessRequest;
        class: T;
        limit?: number;
        offset?: number;
        return?: "entity" | "guid" | "count";
        reverse?: boolean;
        skipCache?: boolean;
        sort?: "cdate" | "mdate" | string | null;
    }

    Type Parameters

    Index

    Properties

    acRequest? class limit? offset? return? reverse? skipCache? sort?

    Properties

    acRequest?: TilmeldAccessRequest

    The level(s) of access control requested.

    Limiting the access control can significantly improve the performance of the query.

    class: T

    The Entity class to query.

    limit?: number

    The limit of entities to be returned. Not needed when using getEntity, as it always returns only one.

    offset?: number

    The offset from the first matching entity, in order, to start retrieving.

    return?: "entity" | "guid" | "count"

    What to return, the entities with their data, just the GUIDs, or just a count.

    reverse?: boolean

    If true, entities will be retrieved from newest to oldest/largest to smallest (with regard to sort).

    skipCache?: boolean

    If true, Nymph will skip the cache and retrieve the entity from the DB.

    sort?: "cdate" | "mdate" | string | null

    How to sort the entities. Should be "cdate", "mdate", the name of a property, or null.

    Settings

    Member Visibility

    On This Page

    Properties