Interface BimQueryOptions

Options accepted by Bim.query.

interface BimQueryOptions {
    forceGetQid?: boolean;
    parameters?: Record<string, unknown>;
    useCache?: boolean;
    virtualFeatures?: unknown;
}

Properties

forceGetQid?: boolean

Include qids even when GET does not request them. Defaults to false.

parameters?: Record<string, unknown>

Named BQL parameter values, without the leading dollar sign.

useCache?: boolean

Cache this query result for this client. Defaults to false.

virtualFeatures?: unknown

Virtual-feature selection sent to the server; omitted uses the client's default.