Skip to main content

WebdaQLString

@webda/core


Type Alias: WebdaQLString<T>

WebdaQLString<T> = string & object

Defined in: packages/ql/lib/webdaql-string.d.ts:13

Marker brand for WebdaQL query strings. T is the type whose attributes @webda/content-mapper validates the query against — typically the model class for Store.query and the configured session type for OperationDefinition.permission.

Erased at runtime — WebdaQLString<X> IS a string, so adoption is zero cost for callers and consumers. The optional brand property lets a plain string variable flow into a WebdaQLString<T> parameter without an explicit cast, while T still differentiates WebdaQLString<Post> from WebdaQLString<User> at the type level.

Type Declaration​

__webdaQL?​

readonly optional __webdaQL?: T

Type Parameters​

T​

T = unknown