@faasjs/knex
FaasJS's sql plugin, base on Knex.
Install
npm install @faasjs/knex
Modules
Classes
Type aliases
Functions
Type aliases
KnexConfig
Ƭ KnexConfig: Object
Type declaration
| Name | Type |
|---|---|
config? | K.Config |
name? | string |
Functions
query
▸ query<TName>(table): QueryBuilder<TableType<TName>, DeferredKeySelection<ResolveTableType<TableType<TName>, "base">, never, false, {}, false, {}, never>[]>
Type parameters
| Name | Type |
|---|---|
TName | extends never |
Parameters
| Name | Type |
|---|---|
table | TName |
Returns
QueryBuilder<TableType<TName>, DeferredKeySelection<ResolveTableType<TableType<TName>, "base">, never, false, {}, false, {}, never>[]>
raw
▸ raw<TResult>(sql, bindings?): Promise<K.Raw<TResult>>
Type parameters
| Name | Type |
|---|---|
TResult | any |
Parameters
| Name | Type | Default value |
|---|---|---|
sql | string | undefined |
bindings | RawBinding[] | ValueDict | [] |
Returns
Promise<K.Raw<TResult>>
transaction
▸ transaction<TResult>(scope, config?): Promise<TResult>
Type parameters
| Name | Type |
|---|---|
TResult | any |
Parameters
| Name | Type |
|---|---|
scope | (trx: Transaction<any, any>) => void | Promise<TResult> |
config? | any |
Returns
Promise<TResult>
useKnex
▸ useKnex(config?): Knex & UseifyPlugin
Parameters
| Name | Type |
|---|---|
config? | KnexConfig |
Returns
Knex & UseifyPlugin