Skip to content

BaseQuery

Defined in: packages/core/application/base.query.ts:31

Base class for application CQRS queries.

Query options and authentication context are pipeline metadata rather than request payload. They are stored as non-enumerable properties so Zod validation and cache-key serialization operate only on the query payload.

export class GetUserQuery extends BaseQuery<SessionPrincipal> {
  constructor(
    public readonly id: string,
    options?: Partial<IQueryOptions>,
    sessionPrincipal?: SessionPrincipal,
  ) {
    super(options, sessionPrincipal);
  }
}

const query = new GetUserQuery(userId, { hydrate: true }, sessionPrincipal);

TSessionPrincipal = unknown

Application-specific principal/session metadata type.

new BaseQuery<TSessionPrincipal>(options?, sessionPrincipal?): BaseQuery<TSessionPrincipal>

Defined in: packages/core/application/base.query.ts:43

Partial<IQueryOptions>

TSessionPrincipal

BaseQuery<TSessionPrincipal>

readonly optional hydrate?: boolean

Defined in: packages/core/application/base.query.ts:34

Query metadata for repositories that read it. FromCache does not: it rehydrates every hit whenever a hydrator applies.

false

IQueryOptions.hydrate


readonly optional refresh?: boolean

Defined in: packages/core/application/base.query.ts:35

Bypass read-through cache lookup and fill, forcing an authoritative read directly from underlying persistence.

false

IQueryOptions.refresh


readonly optional sessionPrincipal?: TSessionPrincipal

Defined in: packages/core/application/base.query.ts:36

get [REQUEST_KIND](): "query"

Defined in: packages/core/application/base.query.ts:39

The kind a pipeline reads from this request: 'query'.

"query"

toJSON(): Record<string, unknown>

Defined in: packages/core/application/base.query.ts:62

Serializes enumerable query payload fields to a plain object.

hydrate, refresh and sessionPrincipal are non-enumerable metadata and stay out of the payload.

Record<string, unknown>

The query payload with undefined fields omitted.