Type Alias Options<T>

Options<T>: {
    class?: T;
    limit?: number;
    offset?: number;
    return?:
        | "entity"
        | "object"
        | "guid"
        | "count";
    reverse?: boolean;
    skipAc?: boolean;
    skipCache?: boolean;
    sort?: "cdate" | "mdate" | string;
    source?: string;
}

Type Parameters

Type declaration

  • Optionalclass?: T

    The Entity class to query.

  • Optionallimit?: number

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

  • Optionaloffset?: number

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

  • Optionalreturn?:
        | "entity"
        | "object"
        | "guid"
        | "count"

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

    'object' is only available on the server, as there are substantial security implications with using it. It returns the full entity data as a simple object. You should only use it for operations where instantiating the entities has an unacceptable performance cost.

  • Optionalreverse?: boolean

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

  • OptionalskipAc?: boolean

    If true, Tilmeld will not filter returned entities according to access controls. (If Tilmeld is installed.) (This is always set to false by the REST endpoint and PubSub server.)

  • OptionalskipCache?: boolean

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

  • Optionalsort?: "cdate" | "mdate" | string

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

  • Optionalsource?: string

    Will be 'client' if the query came from a REST request or the PubSub server. (Mainly used in Tilmeld for access control.)

Settings

Member Visibility