RawQueryFragment <Alias>

Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion.

Index

Constructors

• constructor

Properties

• params
• sql

Accessors

• [toStringTag]
• key

Methods

• [toPrimitive]
• as
• clone
• toJSON
• getKnownFragment
• hasObjectFragments
• isKnownFragment
• isKnownFragmentSymbol

Constructors

constructor

• new RawQueryFragment<Alias>(sql, params): RawQueryFragment<Alias>

• Parameters

  • sql: string

  • params: unknown[] = []

  Returns RawQueryFragment<Alias>

Properties

readonlyparams

params: unknown[] = []

readonlysql

sql: string

Accessors

[toStringTag]

• get [toStringTag](): string

• Returns string

key

• get key(): RawQueryFragmentSymbol

• Returns a unique symbol key for this fragment, creating and caching it on first access.

  ---

  Returns RawQueryFragmentSymbol

Methods

[toPrimitive]

• [toPrimitive](hint): RawQueryFragmentSymbol

• Parameters

  • hint: string

  Returns RawQueryFragmentSymbol

as

• as<A>(alias): RawQueryFragment<A>

• Creates a new fragment with an alias appended via as ??.

  ---

  Parameters

  • alias: A

  Returns RawQueryFragment<A>

clone

• clone(): this

• Returns this

toJSON

• toJSON(): string

• Returns string

staticgetKnownFragment

• getKnownFragment(key): undefined | RawQueryFragment<string>

• Retrieves the RawQueryFragment associated with the given key (instance or symbol).

  ---

  Parameters

  • key: unknown

  Returns undefined | RawQueryFragment<string>

statichasObjectFragments

• hasObjectFragments(object): boolean

• Checks whether an object has any symbol keys that are known raw query fragments.

  ---

  Parameters

  • object: unknown

  Returns boolean

staticisKnownFragment

• isKnownFragment(key): key is symbol | RawQueryFragment<string>

• Checks whether the given value is a RawQueryFragment instance or a known fragment symbol.

  ---

  Parameters

  • key: unknown

  Returns key is symbol | RawQueryFragment<string>

staticisKnownFragmentSymbol

• isKnownFragmentSymbol(key): key is RawQueryFragmentSymbol

• Checks whether the given value is a symbol that maps to a known raw query fragment.

  ---

  Parameters

  • key: unknown

  Returns key is RawQueryFragmentSymbol