Typegres API Reference - v0.2.0
Preparing search index...
PgLsn
Class PgLsn<N>
Type Parameters
in out
N
extends
number
Hierarchy (
View Summary
)
Anynonarray
<
N
>
PgLsn
Index
Constructors
constructor
Properties
[meta]
deserialize
__
typname
__
typname
Text
Methods
-
+
<
<=
<>
=
>
>=
any
Value
any
Value
Transfn
array
Agg
array
Prepend
cast
coalesce
count
cume
Dist
dense
Rank
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
gt
gte
in
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
mode
ne
num
Nonnulls
num
Nulls
percent
Rank
pg
Lsn
Larger
pg
Lsn
Send
pg
Lsn
Smaller
pg
Walfile
Name
pg
Walfile
Name
Offset
pg
Wal
Lsn
Diff
plus
rank
to
Sql
column
from
serialize
Constructors
constructor
new
PgLsn
<
in out
N
extends
number
>
()
:
PgLsn
<
N
>
Type Parameters
in out
N
extends
number
Returns
PgLsn
<
N
>
Properties
[meta]
"[meta]"
:
{
__aggregate
:
PgLsn
<
number
>
;
__any
:
PgLsn
<
any
>
;
__class
:
typeof
PgLsn
;
__nonNullable
:
PgLsn
<
1
>
;
__nullability
:
N
;
__nullable
:
PgLsn
<
0
|
1
>
;
__raw
:
Sql
;
}
deserialize
deserialize
:
(
raw
:
string
)
=>
string
Static
__
typname
__typname
:
Raw
= ...
Static
__
typname
Text
__typnameText
:
string
= "pg_lsn"
Methods
-
"-"
<
M0
extends
Numeric
<
any
>
>
(
arg0
:
M0
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
"-"
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
+
"+"
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<
"<"
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<=
"<="
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
<>
"<>"
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
=
"="
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>
">"
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
>=
">="
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
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
>
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
>
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
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gt
gt
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
gte
gte
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
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
]
>
>
>
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
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
lte
lte
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
max
max
()
:
PgLsn
<
0
|
1
>
Returns
PgLsn
<
0
|
1
>
min
min
()
:
PgLsn
<
0
|
1
>
Returns
PgLsn
<
0
|
1
>
minus
minus
<
M0
extends
Numeric
<
any
>
>
(
arg0
:
M0
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
minus
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
mode
mode
()
:
Anyelement
<
0
|
1
>
Returns
Anyelement
<
0
|
1
>
ne
ne
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
)
:
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Bool
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
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
>
pg
Lsn
Larger
pgLsnLarger
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
,
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
pg
Lsn
Send
pgLsnSend
()
:
Bytea
<
N
>
Returns
Bytea
<
N
>
pg
Lsn
Smaller
pgLsnSmaller
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
,
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
pg
Walfile
Name
pgWalfileName
()
:
Text
<
N
>
Returns
Text
<
N
>
pg
Walfile
Name
Offset
pgWalfileNameOffset
()
:
Record
<
N
>
Returns
Record
<
N
>
pg
Wal
Lsn
Diff
pgWalLsnDiff
<
M0
extends
string
|
PgLsn
<
any
>
>
(
arg0
:
M0
,
)
:
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
PgLsn
<
any
>
Parameters
arg0
:
M0
Returns
Numeric
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
plus
plus
<
M0
extends
string
|
Numeric
<
any
>
>
(
arg0
:
M0
,
)
:
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Numeric
<
any
>
Parameters
arg0
:
M0
Returns
PgLsn
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
rank
rank
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
to
Sql
toSql
()
:
Sql
Returns
Sql
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
-
+
<
<=
<>
=
>
>=
any
Value
any
Value
Transfn
array
Agg
array
Prepend
cast
coalesce
count
cume
Dist
dense
Rank
elem
Contained
By
Multirange
elem
Contained
By
Range
eq
gt
gte
in
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
mode
ne
num
Nonnulls
num
Nulls
percent
Rank
pg
Lsn
Larger
pg
Lsn
Send
pg
Lsn
Smaller
pg
Walfile
Name
pg
Walfile
Name
Offset
pg
Wal
Lsn
Diff
plus
rank
to
Sql
column
from
serialize
Typegres API Reference - v0.2.0
Loading...