Beignet API reference
Preparing search index...
@beignet/core
contracts
query
Variable query
Const
query
:
{
array
<
const
TItem
extends
QueryScalarTransport
>
(
item
:
TItem
,
options
?:
EmptyOptions
,
)
:
QueryArrayTransport
<
TItem
>
;
boolean
()
:
QueryScalarTransport
&
{
kind
:
"boolean"
}
;
date
()
:
QueryScalarTransport
&
{
kind
:
"date"
}
;
dateTime
()
:
QueryScalarTransport
&
{
kind
:
"date-time"
}
;
deepObject
<
const
TFields
extends
Readonly
<
Record
<
string
,
QueryScalarTransport
>
>
,
>
(
fields
:
TFields
,
options
?:
EmptyOptions
,
)
:
QueryDeepObjectTransport
<
TFields
>
;
integer
()
:
QueryScalarTransport
&
{
kind
:
"integer"
}
;
number
()
:
QueryScalarTransport
&
{
kind
:
"number"
}
;
string
()
:
QueryScalarTransport
&
{
kind
:
"string"
}
;
}
= ...
Built-in, OpenAPI-inspectable query parameter transports.
Type Declaration
array
:
function
array
<
const
TItem
extends
QueryScalarTransport
>
(
item
:
TItem
,
options
?:
EmptyOptions
,
)
:
QueryArrayTransport
<
TItem
>
Type Parameters
const
TItem
extends
QueryScalarTransport
Parameters
item
:
TItem
options
:
EmptyOptions
= {}
Returns
QueryArrayTransport
<
TItem
>
boolean
:
function
boolean
()
:
QueryScalarTransport
&
{
kind
:
"boolean"
}
Returns
QueryScalarTransport
&
{
kind
:
"boolean"
}
date
:
function
date
()
:
QueryScalarTransport
&
{
kind
:
"date"
}
Returns
QueryScalarTransport
&
{
kind
:
"date"
}
dateTime
:
function
dateTime
()
:
QueryScalarTransport
&
{
kind
:
"date-time"
}
Returns
QueryScalarTransport
&
{
kind
:
"date-time"
}
deepObject
:
function
deepObject
<
const
TFields
extends
Readonly
<
Record
<
string
,
QueryScalarTransport
>
>
>
(
fields
:
TFields
,
options
?:
EmptyOptions
,
)
:
QueryDeepObjectTransport
<
TFields
>
Type Parameters
const
TFields
extends
Readonly
<
Record
<
string
,
QueryScalarTransport
>
>
Parameters
fields
:
TFields
options
:
EmptyOptions
= {}
Returns
QueryDeepObjectTransport
<
TFields
>
integer
:
function
integer
()
:
QueryScalarTransport
&
{
kind
:
"integer"
}
Returns
QueryScalarTransport
&
{
kind
:
"integer"
}
number
:
function
number
()
:
QueryScalarTransport
&
{
kind
:
"number"
}
Returns
QueryScalarTransport
&
{
kind
:
"number"
}
string
:
function
string
()
:
QueryScalarTransport
&
{
kind
:
"string"
}
Returns
QueryScalarTransport
&
{
kind
:
"string"
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Beignet API reference
Loading...
Built-in, OpenAPI-inspectable query parameter transports.