Typegres API Reference - v0.2.0
Preparing search index...
Numeric
Class Numeric<N>
Type Parameters
in out
N
extends
number
Hierarchy (
View Summary
)
Anynonarray
<
N
>
Numeric
Index
Constructors
constructor
Properties
[meta]
deserialize
__
typname
__
typname
Text
Methods
-
*
/
%
^
+
<
<=
<>
=
>
>=
abs
any
Value
any
Value
Transfn
array
Agg
array
Prepend
avg
cast
ceil
ceiling
coalesce
count
cume
Dist
dense
Rank
div
divide
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
exp
float4
float8
floor
gcd
generate
Series
gt
gte
in
int2
int4
int8
int8
Sum
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
lcm
ln
log
log10
lt
lte
max
min
min
Scale
minus
mod
mode
ne
numeric
numeric
Abs
numeric
Div
Trunc
numeric
Exp
numeric
Inc
numeric
Larger
numeric
Ln
numeric
Log
numeric
Send
numeric
Smaller
numeric
Sqrt
num
Nonnulls
num
Nulls
numrange
Subdiff
percent
Rank
pg
Lsn
pg
Size
Pretty
plus
pow
power
rank
round
scale
sign
sqrt
stddev
stddev
Pop
stddev
Samp
sum
times
to
Sql
trim
Scale
trunc
variance
var
Pop
var
Samp
width
Bucket
column
from
serialize
Constructors
constructor
new
Numeric
<
in out
N
extends
number
>
()
:
Numeric
<
N
>
Type Parameters
in out
N
extends
number
Returns
Numeric
<
N
>
Properties
[meta]
"[meta]"
:
{
__aggregate
:
Numeric
<
number
>
;
__any
:
Numeric
<
any
>
;
__class
:
typeof
Numeric
;
__nonNullable
:
Numeric
<
1
>
;
__nullability
:
N
;
__nullable
:
Numeric
<
0
|
1
>
;
__raw
:
Sql
;
}
deserialize
deserialize
:
(
raw
:
string
)
=>
string
Static
__
typname
__typname
:
Raw
= ...
Static
__
typname
Text
__typnameText
:
string
= "numeric"
Methods
-
"-"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
*
"*"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
/
"/"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
%
"%"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
^
"^"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
+
"+"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"+"
<
M0
extends
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<
"<"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<=
"<="
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<>
"<>"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
=
"="
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>
">"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>=
">="
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
abs
abs
()
:
Numeric
<
N
>
Returns
Numeric
<
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
>
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
>
ceil
ceil
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
ceiling
ceiling
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
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
>
div
div
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
divide
divide
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
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
|
Numeric
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
exp
exp
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
float4
float4
()
:
Float4
<
N
>
Returns
Float4
<
N
>
float8
float8
()
:
Float8
<
N
>
Returns
Float8
<
N
>
floor
floor
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
gcd
gcd
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
generate
Series
generateSeries
<
M0
extends
string
|
Numeric
<
any
>
,
M1
extends
string
|
Numeric
<
any
>
,
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
PgSrf
<
{
generate_series
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
}
,
"generate_series"
,
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
M1
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
PgSrf
<
{
generate_series
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
}
,
"generate_series"
,
>
generateSeries
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
PgSrf
<
{
generate_series
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
}
,
"generate_series"
,
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
PgSrf
<
{
generate_series
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
}
,
"generate_series"
,
>
gt
gt
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gte
gte
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
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
int2
()
:
Int2
<
N
>
Returns
Int2
<
N
>
int4
int4
()
:
Int4
<
N
>
Returns
Int4
<
N
>
int8
int8
()
:
Int8
<
N
>
Returns
Int8
<
N
>
int8
Sum
int8Sum
<
M0
extends
string
|
Int8
<
any
>
>
(
arg0
:
M0
)
:
Numeric
<
1
>
Type Parameters
M0
extends
string
|
Int8
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
1
>
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
>
lcm
lcm
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
ln
ln
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
log
log
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
log
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
log10
log10
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
lt
lt
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lte
lte
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
max
max
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
min
min
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
min
Scale
minScale
()
:
Int4
<
N
>
Returns
Int4
<
N
>
minus
minus
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
mod
mod
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
mode
mode
()
:
Anyelement
<
0
|
1
>
Returns
Anyelement
<
0
|
1
>
ne
ne
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
numeric
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
Abs
numericAbs
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
numeric
Div
Trunc
numericDivTrunc
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
Exp
numericExp
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
numeric
Inc
numericInc
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
numeric
Larger
numericLarger
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
Ln
numericLn
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
numeric
Log
numericLog
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
Send
numericSend
()
:
Bytea
<
N
>
Returns
Bytea
<
N
>
numeric
Smaller
numericSmaller
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
numeric
Sqrt
numericSqrt
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
num
Nonnulls
numNonnulls
()
:
Int4
<
1
>
Returns
Int4
<
1
>
num
Nulls
numNulls
()
:
Int4
<
1
>
Returns
Int4
<
1
>
numrange
Subdiff
numrangeSubdiff
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Float8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Float8
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
percent
Rank
percentRank
()
:
Float8
<
0
|
1
>
Returns
Float8
<
0
|
1
>
pg
Lsn
pgLsn
()
:
PgLsn
<
N
>
Returns
PgLsn
<
N
>
pg
Size
Pretty
pgSizePretty
()
:
Text
<
N
>
Returns
Text
<
N
>
plus
plus
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
plus
<
M0
extends
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
pow
pow
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
power
power
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
rank
rank
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
round
round
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
round
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
scale
scale
()
:
Int4
<
N
>
Returns
Int4
<
N
>
sign
sign
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
sqrt
sqrt
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
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
()
:
Numeric
<
0
|
1
>
Returns
Numeric
<
0
|
1
>
times
times
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
to
Sql
toSql
()
:
Sql
Returns
Sql
trim
Scale
trimScale
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
trunc
trunc
()
:
Numeric
<
N
>
Returns
Numeric
<
N
>
trunc
<
M0
extends
number
|
Int4
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
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
>
width
Bucket
widthBucket
<
M0
extends
string
|
Numeric
<
any
>
,
M1
extends
string
|
Numeric
<
any
>
,
M2
extends
number
|
Int4
<
any
>
,
>
(
arg0
:
M0
,
arg1
:
M1
,
arg2
:
M2
,
)
:
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
M1
extends
string
|
Numeric
<
any
>
M2
extends
number
|
Int4
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
arg2
:
M2
Returns
Int4
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
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
cast
ceil
ceiling
coalesce
count
cume
Dist
dense
Rank
div
divide
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
exp
float4
float8
floor
gcd
generate
Series
gt
gte
in
int2
int4
int8
int8
Sum
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
lcm
ln
log
log10
lt
lte
max
min
min
Scale
minus
mod
mode
ne
numeric
numeric
Abs
numeric
Div
Trunc
numeric
Exp
numeric
Inc
numeric
Larger
numeric
Ln
numeric
Log
numeric
Send
numeric
Smaller
numeric
Sqrt
num
Nonnulls
num
Nulls
numrange
Subdiff
percent
Rank
pg
Lsn
pg
Size
Pretty
plus
pow
power
rank
round
scale
sign
sqrt
stddev
stddev
Pop
stddev
Samp
sum
times
to
Sql
trim
Scale
trunc
variance
var
Pop
var
Samp
width
Bucket
column
from
serialize
Typegres API Reference - v0.2.0
Loading...