Typegres API Reference - v0.2.0
Preparing search index...
Int2
Class Int2<N>
Type Parameters
in out
N
extends
number
Hierarchy (
View Summary
)
Anynonarray
<
N
>
Int2
Index
Constructors
constructor
Properties
[meta]
deserialize
__
typname
__
typname
Text
Methods
-
*
/
&
#
%
+
<
<<
<=
<>
=
>
>=
>>
|
abs
any
Value
any
Value
Transfn
array
Agg
array
Prepend
avg
bit
And
bit
Or
bit
Xor
cast
coalesce
count
cume
Dist
dense
Rank
divide
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
float4
float8
gt
gte
in
int2
Abs
int2
And
int2
Larger
int2
Not
int2
Or
int2
Send
int2
Shl
int2
Shr
int2
Smaller
int2
Xor
int4
int8
is
Not
Null
is
Null
json
Agg
json
Agg
Strict
jsonb
Agg
jsonb
Agg
Strict
jsonb
Object
Agg
jsonb
Object
Agg
Strict
jsonb
Object
Agg
Unique
jsonb
Object
Agg
Unique
Strict
json
Object
Agg
json
Object
Agg
Strict
json
Object
Agg
Unique
json
Object
Agg
Unique
Strict
lt
lte
max
min
minus
mod
mode
ne
numeric
num
Nonnulls
num
Nulls
percent
Rank
plus
rank
stddev
stddev
Pop
stddev
Samp
sum
times
to
Sql
variance
var
Pop
var
Samp
column
from
serialize
Constructors
constructor
new
Int2
<
in out
N
extends
number
>
()
:
Int2
<
N
>
Type Parameters
in out
N
extends
number
Returns
Int2
<
N
>
Properties
[meta]
"[meta]"
:
{
__aggregate
:
Int2
<
number
>
;
__any
:
Int2
<
any
>
;
__class
:
typeof
Int2
;
__nonNullable
:
Int2
<
1
>
;
__nullability
:
N
;
__nullable
:
Int2
<
0
|
1
>
;
__raw
:
Sql
;
}
deserialize
deserialize
:
(
raw
:
string
)
=>
number
Static
__
typname
__typname
:
Raw
= ...
Static
__
typname
Text
__typnameText
:
string
= "int2"
Methods
-
"-"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"-"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"-"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
*
"*"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"*"
<
M0
extends
Money
<
any
>
>
(
arg0
:
M0
)
:
Money
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Money
<
any
>
Parameters
arg0
:
M0
Returns
Money
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"*"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"*"
<
M0
extends
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
/
"/"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"/"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"/"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
&
"&"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
#
"#"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
%
"%"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
+
"+"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"+"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"+"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<
"<"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<<
"<<"
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<=
"<="
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<="
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<="
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<>
"<>"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<>"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"<>"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
=
"="
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"="
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"="
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>
">"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
">"
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
">"
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>=
">="
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
">="
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
">="
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>>
">>"
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
|
"|"
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
abs
abs
()
:
Int2
<
N
>
Returns
Int2
<
N
>
any
Value
anyValue
()
:
Anyelement
<
0
|
1
>
Returns
Anyelement
<
0
|
1
>
any
Value
Transfn
anyValueTransfn
<
M0
extends
Anyelement
<
any
>
>
(
arg0
:
M0
,
)
:
Anyelement
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Anyelement
<
any
>
Parameters
arg0
:
M0
Returns
Anyelement
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
array
Agg
arrayAgg
()
:
Anyarray
<
Any
<
any
>
,
0
|
1
>
Returns
Anyarray
<
Any
<
any
>
,
0
|
1
>
array
Prepend
arrayPrepend
<
M0
extends
Anycompatiblearray
<
Any
<
any
>
,
any
>
>
(
arg0
:
M0
,
)
:
Anycompatiblearray
<
Any
<
any
>
,
1
>
Type Parameters
M0
extends
Anycompatiblearray
<
Any
<
any
>
,
any
>
Parameters
arg0
:
M0
Returns
Anycompatiblearray
<
Any
<
any
>
,
1
>
avg
avg
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
bit
And
bitAnd
()
:
Int2
<
0
|
1
>
Returns
Int2
<
0
|
1
>
bit
Or
bitOr
()
:
Int2
<
0
|
1
>
Returns
Int2
<
0
|
1
>
bit
Xor
bitXor
()
:
Int2
<
0
|
1
>
Returns
Int2
<
0
|
1
>
cast
cast
<
T
extends
typeof
Any
>
(
cls
:
T
,
)
:
[
number
]
extends
[
N
]
?
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__aggregate
:
U
}
}
?
U
:
InstanceType
<
T
>
:
[
N
]
extends
[
1
]
?
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
InstanceType
<
T
>
:
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nullable
:
U
}
}
?
U
:
InstanceType
<
T
>
Type Parameters
T
extends
typeof
Any
Parameters
cls
:
T
Returns
[
number
]
extends
[
N
]
?
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__aggregate
:
U
}
}
?
U
:
InstanceType
<
T
>
:
[
N
]
extends
[
1
]
?
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
InstanceType
<
T
>
:
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nullable
:
U
}
}
?
U
:
InstanceType
<
T
>
coalesce
coalesce
<
T
extends
Any
<
any
>
,
R
extends
Any
<
any
>
>
(
this
:
T
,
rhs
:
R
,
)
:
0
extends
NullOf
<
R
>
?
T
:
T
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
T
Type Parameters
T
extends
Any
<
any
>
R
extends
Any
<
any
>
Parameters
this
:
T
rhs
:
R
Returns
0
extends
NullOf
<
R
>
?
T
:
T
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
T
count
count
()
:
Int8
<
1
>
Returns
Int8
<
1
>
cume
Dist
cumeDist
()
:
Float8
<
0
|
1
>
Returns
Float8
<
0
|
1
>
dense
Rank
denseRank
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
divide
divide
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
divide
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
,
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
divide
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
elem
Contained
By
Multirange
elemContainedByMultirange
<
M0
extends
Anymultirange
<
Any
<
any
>
,
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Anymultirange
<
Any
<
any
>
,
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
elem
Contained
By
Range
elemContainedByRange
<
M0
extends
Anyrange
<
Any
<
any
>
,
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Anyrange
<
Any
<
any
>
,
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
eq
eq
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
eq
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
eq
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
float4
float4
()
:
Float4
<
N
>
Returns
Float4
<
N
>
float8
float8
()
:
Float8
<
N
>
Returns
Float8
<
N
>
gt
gt
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gt
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gt
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gte
gte
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gte
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gte
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
in
in
<
T
extends
Any
<
any
>
,
Vs
extends
[
(
T
extends
{
"[meta]"
:
{
__any
:
A
}
}
?
A
:
Any
<
any
>
)
|
TsTypeOf
<
T
>
,
...
(
TsTypeOf
<
T
>
|
(
T
extends
{
"[meta]"
:
{
__any
:
A
}
}
?
A
:
Any
<
any
>
))
[]
,
]
,
>
(
this
:
T
,
...
vals
:
Vs
,
)
:
Bool
<
StrictNull
<
NullOf
<
T
>
|
NullOf
<
Vs
[
number
]
>
>
>
Type Parameters
T
extends
Any
<
any
>
Vs
extends
[
(
T
extends
{
"[meta]"
:
{
__any
:
A
}
}
?
A
:
Any
<
any
>
)
|
TsTypeOf
<
T
>
,
...
(
TsTypeOf
<
T
>
|
(
T
extends
{
"[meta]"
:
{
__any
:
A
}
}
?
A
:
Any
<
any
>
))
[]
,
]
Parameters
this
:
T
...
vals
:
Vs
Returns
Bool
<
StrictNull
<
NullOf
<
T
>
|
NullOf
<
Vs
[
number
]
>
>
>
int2
Abs
int2Abs
()
:
Int2
<
N
>
Returns
Int2
<
N
>
int2
And
int2And
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Larger
int2Larger
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Not
int2Not
()
:
Int2
<
N
>
Returns
Int2
<
N
>
int2
Or
int2Or
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Send
int2Send
()
:
Bytea
<
N
>
Returns
Bytea
<
N
>
int2
Shl
int2Shl
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Shr
int2Shr
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Smaller
int2Smaller
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int2
Xor
int2Xor
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
,
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
int4
int4
()
:
Int4
<
N
>
Returns
Int4
<
N
>
int8
int8
()
:
Int8
<
N
>
Returns
Int8
<
N
>
is
Not
Null
isNotNull
()
:
Bool
<
1
>
Returns
Bool
<
1
>
is
Null
isNull
()
:
Bool
<
1
>
Returns
Bool
<
1
>
json
Agg
jsonAgg
()
:
Json
<
0
|
1
>
Returns
Json
<
0
|
1
>
json
Agg
Strict
jsonAggStrict
()
:
Json
<
0
|
1
>
Returns
Json
<
0
|
1
>
jsonb
Agg
jsonbAgg
()
:
Jsonb
<
0
|
1
>
Returns
Jsonb
<
0
|
1
>
jsonb
Agg
Strict
jsonbAggStrict
()
:
Jsonb
<
0
|
1
>
Returns
Jsonb
<
0
|
1
>
jsonb
Object
Agg
jsonbObjectAgg
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Jsonb
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Jsonb
<
0
|
1
>
jsonb
Object
Agg
Strict
jsonbObjectAggStrict
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Jsonb
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Jsonb
<
0
|
1
>
jsonb
Object
Agg
Unique
jsonbObjectAggUnique
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Jsonb
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Jsonb
<
0
|
1
>
jsonb
Object
Agg
Unique
Strict
jsonbObjectAggUniqueStrict
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Jsonb
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Jsonb
<
0
|
1
>
json
Object
Agg
jsonObjectAgg
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Json
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Json
<
0
|
1
>
json
Object
Agg
Strict
jsonObjectAggStrict
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Json
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Json
<
0
|
1
>
json
Object
Agg
Unique
jsonObjectAggUnique
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Json
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Json
<
0
|
1
>
json
Object
Agg
Unique
Strict
jsonObjectAggUniqueStrict
<
M0
extends
string
|
Any
<
any
>
>
(
arg0
:
M0
)
:
Json
<
0
|
1
>
Type Parameters
M0
extends
string
|
Any
<
any
>
Parameters
arg0
:
M0
Returns
Json
<
0
|
1
>
lt
lt
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lt
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lt
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lte
lte
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lte
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lte
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
max
max
()
:
Int2
<
0
|
1
>
Returns
Int2
<
0
|
1
>
min
min
()
:
Int2
<
0
|
1
>
Returns
Int2
<
0
|
1
>
minus
minus
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
minus
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
minus
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
mod
mod
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
mode
mode
()
:
Anyelement
<
0
|
1
>
Returns
Anyelement
<
0
|
1
>
ne
ne
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
ne
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
ne
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
numeric
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
num
Nonnulls
numNonnulls
()
:
Int4
<
1
>
Returns
Int4
<
1
>
num
Nulls
numNulls
()
:
Int4
<
1
>
Returns
Int4
<
1
>
percent
Rank
percentRank
()
:
Float8
<
0
|
1
>
Returns
Float8
<
0
|
1
>
plus
plus
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
plus
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
plus
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
rank
rank
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
stddev
stddev
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
stddev
Pop
stddevPop
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
stddev
Samp
stddevSamp
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
sum
sum
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
times
times
<
M0
extends
number
|
Int2
<
any
>
>
(
arg0
:
M0
)
:
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int2
<
any
>
Parameters
arg0
:
M0
Returns
Int2
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
times
<
M0
extends
Money
<
any
>
>
(
arg0
:
M0
)
:
Money
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Money
<
any
>
Parameters
arg0
:
M0
Returns
Money
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
times
<
M0
extends
Int4
<
any
>
>
(
arg0
:
M0
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
times
<
M0
extends
Int8
<
any
>
>
(
arg0
:
M0
)
:
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Int8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
to
Sql
toSql
()
:
Sql
Returns
Sql
variance
variance
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
var
Pop
varPop
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
var
Samp
varSamp
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
Static
column
column
<
T
extends
typeof
Any
,
Opts
extends
ColumnOpts
=
{}
>
(
this
:
T
,
_opts
?:
Opts
,
)
:
InstanceType
<
T
>
&
{
"[meta]"
:
{
__required
:
Opts
extends
{
nonNull
:
true
}
?
Opts
extends
{
default
:
any
}
|
{
generated
:
true
}
?
false
:
true
:
false
;
}
;
}
Type Parameters
T
extends
typeof
Any
Opts
extends
ColumnOpts
=
{}
Parameters
this
:
T
Optional
_opts
:
Opts
Returns
InstanceType
<
T
>
&
{
"[meta]"
:
{
__required
:
Opts
extends
{
nonNull
:
true
}
?
Opts
extends
{
default
:
any
}
|
{
generated
:
true
}
?
false
:
true
:
false
;
}
;
}
Static
from
from
<
T
extends
typeof
Any
>
(
this
:
T
,
v
:
Sql
,
)
:
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nullable
:
U
}
}
?
U
:
InstanceType
<
T
>
Type Parameters
T
extends
typeof
Any
Parameters
this
:
T
v
:
Sql
Returns
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nullable
:
U
}
}
?
U
:
InstanceType
<
T
>
from
<
T
extends
typeof
Any
>
(
this
:
T
,
v
:
unknown
,
)
:
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
InstanceType
<
T
>
Type Parameters
T
extends
typeof
Any
Parameters
this
:
T
v
:
unknown
Returns
InstanceType
<
T
>
extends
{
"[meta]"
:
{
__nonNullable
:
U
}
}
?
U
:
InstanceType
<
T
>
Static
serialize
serialize
(
v
:
unknown
)
:
Any
<
any
>
Parameters
v
:
unknown
Returns
Any
<
any
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
[meta]
deserialize
__
typname
__
typname
Text
Methods
-
*
/
&
#
%
+
<
<<
<=
<>
=
>
>=
>>
|
abs
any
Value
any
Value
Transfn
array
Agg
array
Prepend
avg
bit
And
bit
Or
bit
Xor
cast
coalesce
count
cume
Dist
dense
Rank
divide
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
float4
float8
gt
gte
in
int2
Abs
int2
And
int2
Larger
int2
Not
int2
Or
int2
Send
int2
Shl
int2
Shr
int2
Smaller
int2
Xor
int4
int8
is
Not
Null
is
Null
json
Agg
json
Agg
Strict
jsonb
Agg
jsonb
Agg
Strict
jsonb
Object
Agg
jsonb
Object
Agg
Strict
jsonb
Object
Agg
Unique
jsonb
Object
Agg
Unique
Strict
json
Object
Agg
json
Object
Agg
Strict
json
Object
Agg
Unique
json
Object
Agg
Unique
Strict
lt
lte
max
min
minus
mod
mode
ne
numeric
num
Nonnulls
num
Nulls
percent
Rank
plus
rank
stddev
stddev
Pop
stddev
Samp
sum
times
to
Sql
variance
var
Pop
var
Samp
column
from
serialize
Typegres API Reference - v0.2.0
Loading...