@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): K.QueryBuilder<K.TableType<TName>, { _aliases: {} ; _base: K.ResolveTableType<K.TableType<TName>, "base"> ; _hasSelection: false ; _intersectProps: {} ; _keys: never ; _single: false ; _unionProps: never }[]>
Type parameters
| Name | Type |
|---|---|
TName | extends "test" |
Parameters
| Name | Type |
|---|---|
table | TName |
Returns
K.QueryBuilder<K.TableType<TName>, { _aliases: {} ; _base: K.ResolveTableType<K.TableType<TName>, "base"> ; _hasSelection: false ; _intersectProps: {} ; _keys: never ; _single: false ; _unionProps: never }[]>
▸ query<TName, TResult>(table): K.QueryBuilder<TName, TResult>
Type parameters
| Name | Type |
|---|---|
TName | extends Object = any |
TResult | any[] |
Parameters
| Name | Type |
|---|---|
table | string |
Returns
K.QueryBuilder<TName, TResult>
raw
▸ raw<TResult>(sql, bindings?): Promise<TResult>
Type parameters
| Name | Type |
|---|---|
TResult | any |
Parameters
| Name | Type | Default value |
|---|---|---|
sql | string | undefined |
bindings | ValueDict | RawBinding[] | [] |
Returns
Promise<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?): UseifyPlugin<Knex>
Parameters
| Name | Type |
|---|---|
config? | KnexConfig |
Returns
UseifyPlugin<Knex>