Skip to main content
Version: 4.5

Namespace: Knex#

knex.Knex

Table of contents#

Classes#

Interfaces#

Type aliases#

AsyncConnectionConfigProvider#

Ƭ AsyncConnectionConfigProvider: () => Promise<StaticConnectionConfig>

Type declaration:#

▸ (): Promise<StaticConnectionConfig>

Returns: Promise<StaticConnectionConfig>

Defined in: node_modules/knex/types/index.d.ts:1891


ClearStatements#

Ƭ ClearStatements: with | select | columns | hintComments | where | union | join | group | order | having | limit | offset | counter | counters

Defined in: node_modules/knex/types/index.d.ts:463


ColumnDescriptor#

Ƭ ColumnDescriptor<TRecord, TResult>: string | Raw | QueryBuilder<TRecord, TResult> | Dict<string>

Type parameters:#

Name
TRecord
TResult

Defined in: node_modules/knex/types/index.d.ts:409


CompositeTableType#

Ƭ CompositeTableType<TBase, TInsert, TUpdate>: object

Type parameters:#

NameDefault
TBase-
TInsertTBase
TUpdatePartial<TInsert>

Type declaration:#

NameType
baseTBase
insertTInsert
updateTUpdate

Defined in: node_modules/knex/types/index.d.ts:439


ConnectionConfigProvider#

Ƭ ConnectionConfigProvider: SyncConnectionConfigProvider | AsyncConnectionConfigProvider

Defined in: node_modules/knex/types/index.d.ts:1889


DbColumn#

Ƭ DbColumn<TColumn>: Readonly<MaybeRawColumn<TColumn>>

Type parameters:#

Name
TColumn

Defined in: node_modules/knex/types/index.d.ts:433


DbRecord#

Ƭ DbRecord<TRecord>: Readonly<SafePartial<MaybeRawRecord<TRecord>>>

Type parameters:#

Name
TRecord

Defined in: node_modules/knex/types/index.d.ts:435


DbRecordArr#

Ƭ DbRecordArr<TRecord>: Readonly<MaybeArray<DbRecord<TRecord>>>

Type parameters:#

Name
TRecord

Defined in: node_modules/knex/types/index.d.ts:437


ExposedPromiseKeys#

Ƭ ExposedPromiseKeys: then | catch | finally

Defined in: node_modules/knex/types/index.d.ts:1639


InferrableColumnDescriptor#

Ƭ InferrableColumnDescriptor<TRecord>: keyof TRecord | Ref<any, any> | Dict<keyof TRecord>

Type parameters:#

NameType
TRecordobject

Defined in: node_modules/knex/types/index.d.ts:415


IntersectAliases#

Ƭ IntersectAliases<AliasUT>: UnionToIntersection<IncompatibleToAlt<AliasUT extends infer I[] ? I extends Ref<any, infer TMapping> ? TMapping : I : never, Dict, {}>>

Type parameters:#

Name
AliasUT

Defined in: node_modules/knex/types/index.d.ts:905


LogFn#

Ƭ LogFn: (message: any) => void

Type declaration:#

▸ (message: any): void

Parameters:#

NameType
messageany

Returns: void

Defined in: node_modules/knex/types/index.d.ts:2098


Lookup#

Ƭ Lookup<TRegistry, TKey, TDefault>: TKey extends keyof TRegistry ? TRegistry[TKey] : TDefault

Type parameters:#

NameTypeDefault
TRegistryobject-
TKeystring-
TDefault-never

Defined in: node_modules/knex/types/index.d.ts:422


MaybeRawColumn#

Ƭ MaybeRawColumn<TColumn>: TColumn | Raw<TColumn>

Type parameters:#

Name
TColumn

Defined in: node_modules/knex/types/index.d.ts:427


MaybeRawRecord#

Ƭ MaybeRawRecord<TRecord>: { [K in keyof TRecord]: MaybeRawColumn<TRecord[K]>}

Type parameters:#

Name
TRecord

Defined in: node_modules/knex/types/index.d.ts:429


QueryCallback#

Ƭ QueryCallback<TRecord, TResult>: (this: QueryBuilder<TRecord, TResult>, builder: QueryBuilder<TRecord, TResult>) => void

Type parameters:#

NameDefault
TRecordany
TResultunknown[]

Type declaration:#

▸ (this: QueryBuilder<TRecord, TResult>, builder: QueryBuilder<TRecord, TResult>): void

Parameters:#

NameType
thisQueryBuilder<TRecord, TResult>
builderQueryBuilder<TRecord, TResult>

Returns: void

Defined in: node_modules/knex/types/index.d.ts:1577


QueryCallbackWithArgs#

Ƭ QueryCallbackWithArgs<TRecord, TResult>: (this: QueryBuilder<TRecord, TResult>, builder: QueryBuilder<TRecord, TResult>, ...args: any[]) => void

Type parameters:#

NameDefault
TRecordany
TResultunknown[]

Type declaration:#

▸ (this: QueryBuilder<TRecord, TResult>, builder: QueryBuilder<TRecord, TResult>, ...args: any[]): void

Parameters:#

NameType
thisQueryBuilder<TRecord, TResult>
builderQueryBuilder<TRecord, TResult>
...argsany[]

Returns: void

Defined in: node_modules/knex/types/index.d.ts:1582


RawBinding#

Ƭ RawBinding: Value | QueryBuilder

Defined in: node_modules/knex/types/index.d.ts:1487


RedshiftConnectionConfig#

Ƭ RedshiftConnectionConfig: PgConnectionConfig

Defined in: node_modules/knex/types/index.d.ts:2060


ResolveTableType#

Ƭ ResolveTableType<TCompositeTableType, TScope>: TCompositeTableType extends CompositeTableType<unknown> ? TCompositeTableType[TScope] : TCompositeTableType

Type parameters:#

NameTypeDefault
TCompositeTableType--
TScopeTableInterfaceScopebase

Defined in: node_modules/knex/types/index.d.ts:451


StaticConnectionConfig#

Ƭ StaticConnectionConfig: ConnectionConfig | MariaSqlConnectionConfig | MySqlConnectionConfig | MySql2ConnectionConfig | MsSqlConnectionConfig | OracleDbConnectionConfig | PgConnectionConfig | RedshiftConnectionConfig | Sqlite3ConnectionConfig | SocketConnectionConfig

Defined in: node_modules/knex/types/index.d.ts:1877


SyncConnectionConfigProvider#

Ƭ SyncConnectionConfigProvider: () => StaticConnectionConfig

Type declaration:#

▸ (): StaticConnectionConfig

Returns: StaticConnectionConfig

Defined in: node_modules/knex/types/index.d.ts:1890


TableDescriptor#

Ƭ TableDescriptor: string | Raw | QueryBuilder

Defined in: node_modules/knex/types/index.d.ts:420


TableInterfaceScope#

Ƭ TableInterfaceScope: keyof CompositeTableType<unknown>

Defined in: node_modules/knex/types/index.d.ts:447


TableNames#

Ƭ TableNames: keyof Tables

Defined in: node_modules/knex/types/index.d.ts:445


TableType#

Ƭ TableType<TTable>: Tables[TTable]

Type parameters:#

NameType
TTablekeyof Tables

Defined in: node_modules/knex/types/index.d.ts:449


Value#

Ƭ Value: string | number | boolean | null | Date | string[] | number[] | Date[] | boolean[] | Buffer | Raw

Defined in: node_modules/knex/types/index.d.ts:393

Variables#

RefMemberTag#

Const RefMemberTag: unique symbol

Defined in: node_modules/knex/types/index.d.ts:1518

Last updated on by Renovate Bot