Typegres API Reference - v0.2.0
Preparing search index...
Regconfig
Class Regconfig<N>
Type Parameters
in out
N
extends
number
Hierarchy (
View Summary
)
Anynonarray
<
N
>
Regconfig
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
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
jsonb
To
Tsvector
json
Object
Agg
json
Object
Agg
Strict
json
Object
Agg
Unique
json
Object
Agg
Unique
Strict
json
To
Tsvector
mode
num
Nonnulls
num
Nulls
percent
Rank
phraseto
Tsquery
plainto
Tsquery
rank
regconfigsend
to
Sql
to
Tsquery
to
Tsvector
ts
Headline
websearch
To
Tsquery
column
from
serialize
Constructors
constructor
new
Regconfig
<
in out
N
extends
number
>
()
:
Regconfig
<
N
>
Type Parameters
in out
N
extends
number
Returns
Regconfig
<
N
>
Properties
[meta]
"[meta]"
:
{
__aggregate
:
Regconfig
<
number
>
;
__any
:
Regconfig
<
any
>
;
__class
:
typeof
Regconfig
;
__nonNullable
:
Regconfig
<
1
>
;
__nullability
:
N
;
__nullable
:
Regconfig
<
0
|
1
>
;
__raw
:
Sql
;
}
deserialize
deserialize
:
(
raw
:
string
)
=>
string
Static
__
typname
__typname
:
Raw
= ...
Static
__
typname
Text
__typnameText
:
string
= "regconfig"
Methods
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
>
>
>
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
>
jsonb
To
Tsvector
jsonbToTsvector
<
M0
extends
string
|
Jsonb
<
any
>
,
M1
extends
string
|
Jsonb
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
Type Parameters
M0
extends
string
|
Jsonb
<
any
>
M1
extends
string
|
Jsonb
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
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
>
json
To
Tsvector
jsonToTsvector
<
M0
extends
string
|
Json
<
any
>
,
M1
extends
string
|
Jsonb
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
Type Parameters
M0
extends
string
|
Json
<
any
>
M1
extends
string
|
Jsonb
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
mode
mode
()
:
Anyelement
<
0
|
1
>
Returns
Anyelement
<
0
|
1
>
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
>
phraseto
Tsquery
phrasetoTsquery
<
M0
extends
string
|
Text
<
any
>
>
(
arg0
:
M0
,
)
:
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Text
<
any
>
Parameters
arg0
:
M0
Returns
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
plainto
Tsquery
plaintoTsquery
<
M0
extends
string
|
Text
<
any
>
>
(
arg0
:
M0
,
)
:
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Text
<
any
>
Parameters
arg0
:
M0
Returns
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
rank
rank
()
:
Int8
<
0
|
1
>
Returns
Int8
<
0
|
1
>
regconfigsend
regconfigsend
()
:
Bytea
<
N
>
Returns
Bytea
<
N
>
to
Sql
toSql
()
:
Sql
Returns
Sql
to
Tsquery
toTsquery
<
M0
extends
string
|
Text
<
any
>
>
(
arg0
:
M0
,
)
:
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Text
<
any
>
Parameters
arg0
:
M0
Returns
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
to
Tsvector
toTsvector
<
M0
extends
Text
<
any
>
>
(
arg0
:
M0
)
:
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Text
<
any
>
Parameters
arg0
:
M0
Returns
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
toTsvector
<
M0
extends
Jsonb
<
any
>
>
(
arg0
:
M0
,
)
:
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Jsonb
<
any
>
Parameters
arg0
:
M0
Returns
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
toTsvector
<
M0
extends
Json
<
any
>
>
(
arg0
:
M0
)
:
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
Json
<
any
>
Parameters
arg0
:
M0
Returns
Tsvector
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
ts
Headline
tsHeadline
<
M0
extends
Json
<
any
>
,
M1
extends
Tsquery
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
Json
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
Type Parameters
M0
extends
Json
<
any
>
M1
extends
Tsquery
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
Json
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
tsHeadline
<
M0
extends
Text
<
any
>
,
M1
extends
Tsquery
<
any
>
,
M2
extends
Text
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
arg2
:
M2
,
)
:
Text
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
Type Parameters
M0
extends
Text
<
any
>
M1
extends
Tsquery
<
any
>
M2
extends
Text
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
arg2
:
M2
Returns
Text
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
tsHeadline
<
M0
extends
Text
<
any
>
,
M1
extends
Tsquery
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
Text
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
Type Parameters
M0
extends
Text
<
any
>
M1
extends
Tsquery
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
Text
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
tsHeadline
<
M0
extends
Json
<
any
>
,
M1
extends
Tsquery
<
any
>
,
M2
extends
Text
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
arg2
:
M2
,
)
:
Json
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
Type Parameters
M0
extends
Json
<
any
>
M1
extends
Tsquery
<
any
>
M2
extends
Text
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
arg2
:
M2
Returns
Json
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
tsHeadline
<
M0
extends
Jsonb
<
any
>
,
M1
extends
Tsquery
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
)
:
Jsonb
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
Type Parameters
M0
extends
Jsonb
<
any
>
M1
extends
Tsquery
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
Returns
Jsonb
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
>
>
tsHeadline
<
M0
extends
Jsonb
<
any
>
,
M1
extends
Tsquery
<
any
>
,
M2
extends
Text
<
any
>
>
(
arg0
:
M0
,
arg1
:
M1
,
arg2
:
M2
,
)
:
Jsonb
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
Type Parameters
M0
extends
Jsonb
<
any
>
M1
extends
Tsquery
<
any
>
M2
extends
Text
<
any
>
Parameters
arg0
:
M0
arg1
:
M1
arg2
:
M2
Returns
Jsonb
<
StrictNull
<
N
|
NullOf
<
M0
>
|
NullOf
<
M1
>
|
NullOf
<
M2
>
>
>
websearch
To
Tsquery
websearchToTsquery
<
M0
extends
string
|
Text
<
any
>
>
(
arg0
:
M0
,
)
:
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
Type Parameters
M0
extends
string
|
Text
<
any
>
Parameters
arg0
:
M0
Returns
Tsquery
<
StrictNull
<
N
|
NullOf
<
M0
>
>
>
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
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
jsonb
To
Tsvector
json
Object
Agg
json
Object
Agg
Strict
json
Object
Agg
Unique
json
Object
Agg
Unique
Strict
json
To
Tsvector
mode
num
Nonnulls
num
Nulls
percent
Rank
phraseto
Tsquery
plainto
Tsquery
rank
regconfigsend
to
Sql
to
Tsquery
to
Tsvector
ts
Headline
websearch
To
Tsquery
column
from
serialize
Typegres API Reference - v0.2.0
Loading...