cton-js
Preparing search index...
default
Variable default
default
:
{
Binary
:
BinaryStatic
;
clearTypeRegistry
:
()
=>
void
;
Decoder
:
typeof
Decoder
;
dump
:
(
payload
:
unknown
,
options
?:
DumpOptions
)
=>
string
;
dumpBinary
:
(
data
:
unknown
,
options
?:
BinaryOptions
)
=>
Buffer
;
dumpStream
:
(
enumerable
:
Iterable
<
unknown
>
,
io
:
WritableStreamLike
,
options
?:
DumpStreamOptions
,
)
=>
WritableStreamLike
;
Encoder
:
typeof
Encoder
;
generate
:
(
payload
:
unknown
,
options
?:
DumpOptions
)
=>
string
;
isValid
:
(
ctonString
:
string
)
=>
boolean
;
load
:
(
ctonString
:
string
|
number
,
options
?:
LoadOptions
)
=>
unknown
;
loadBinary
:
(
binary
:
|
ArrayBuffer
|
Buffer
<
ArrayBufferLike
>
|
Uint8Array
<
ArrayBufferLike
>
,
)
=>
unknown
;
loadStream
:
(
io
:
Iterable
<
string
>
,
options
?:
StreamOptions
,
)
=>
Generator
<
unknown
,
void
,
unknown
>
;
loadStreamAsync
:
(
io
:
AsyncIterable
<
string
>
,
options
?:
StreamOptions
,
)
=>
AsyncGenerator
<
unknown
,
void
,
unknown
>
;
parse
:
(
ctonString
:
string
|
number
,
options
?:
LoadOptions
)
=>
unknown
;
ParseError
:
typeof
ParseError
;
registerType
:
<
T
>
(
ctor
:
new
(
...
args
:
any
[]
)
=>
T
,
options
?:
RegisterTypeOptions
,
transform
:
(
value
:
T
)
=>
unknown
,
)
=>
void
;
schema
:
(
block
:
(
builder
:
Builder
)
=>
SchemaNode
)
=>
SchemaNode
;
Schema
:
{
AnySchema
:
typeof
AnySchema
;
ArrayBuilder
:
typeof
ArrayBuilder
;
ArraySchema
:
typeof
ArraySchema
;
Builder
:
typeof
Builder
;
define
:
(
block
:
(
builder
:
Builder
)
=>
SchemaNode
)
=>
SchemaNode
;
Error
:
typeof
SchemaError
;
Node
:
typeof
SchemaNode
;
NullableSchema
:
typeof
NullableSchema
;
ObjectBuilder
:
typeof
ObjectBuilder
;
ObjectSchema
:
typeof
ObjectSchema
;
OptionalSchema
:
typeof
OptionalSchema
;
PATH_ROOT
:
string
;
Result
:
typeof
SchemaResult
;
ScalarSchema
:
typeof
ScalarSchema
;
}
;
stats
:
(
data
:
unknown
)
=>
Stats
;
Stats
:
typeof
Stats
;
statsHash
:
(
data
:
unknown
)
=>
StatsJSON
;
StreamReader
:
typeof
StreamReader
;
StreamWriter
:
typeof
StreamWriter
;
typeRegistry
:
TypeRegistry
;
TypeRegistry
:
typeof
TypeRegistry
;
unregisterType
:
<
T
>
(
ctor
:
new
(
...
args
:
any
[]
)
=>
T
)
=>
void
;
validate
:
(
ctonString
:
string
)
=>
ValidationResult
;
validateSchema
:
(
data
:
unknown
,
schemaDef
:
SchemaNode
)
=>
SchemaResult
;
ValidationError
:
typeof
ValidationError
;
ValidationResult
:
typeof
ValidationResult
;
Validator
:
typeof
Validator
;
VERSION
:
string
;
}
Type Declaration
Binary
:
BinaryStatic
clearTypeRegistry
:
()
=>
void
Decoder
:
typeof
Decoder
dump
:
(
payload
:
unknown
,
options
?:
DumpOptions
)
=>
string
dumpBinary
:
(
data
:
unknown
,
options
?:
BinaryOptions
)
=>
Buffer
dumpStream
:
(
enumerable
:
Iterable
<
unknown
>
,
io
:
WritableStreamLike
,
options
?:
DumpStreamOptions
,
)
=>
WritableStreamLike
Encoder
:
typeof
Encoder
generate
:
(
payload
:
unknown
,
options
?:
DumpOptions
)
=>
string
Alias for dump
isValid
:
(
ctonString
:
string
)
=>
boolean
load
:
(
ctonString
:
string
|
number
,
options
?:
LoadOptions
)
=>
unknown
loadBinary
:
(
binary
:
|
ArrayBuffer
|
Buffer
<
ArrayBufferLike
>
|
Uint8Array
<
ArrayBufferLike
>
,
)
=>
unknown
loadStream
:
(
io
:
Iterable
<
string
>
,
options
?:
StreamOptions
,
)
=>
Generator
<
unknown
,
void
,
unknown
>
loadStreamAsync
:
(
io
:
AsyncIterable
<
string
>
,
options
?:
StreamOptions
,
)
=>
AsyncGenerator
<
unknown
,
void
,
unknown
>
parse
:
(
ctonString
:
string
|
number
,
options
?:
LoadOptions
)
=>
unknown
Alias for load
ParseError
:
typeof
ParseError
registerType
:
<
T
>
(
ctor
:
new
(
...
args
:
any
[]
)
=>
T
,
options
?:
RegisterTypeOptions
,
transform
:
(
value
:
T
)
=>
unknown
,
)
=>
void
schema
:
(
block
:
(
builder
:
Builder
)
=>
SchemaNode
)
=>
SchemaNode
Schema
:
{
AnySchema
:
typeof
AnySchema
;
ArrayBuilder
:
typeof
ArrayBuilder
;
ArraySchema
:
typeof
ArraySchema
;
Builder
:
typeof
Builder
;
define
:
(
block
:
(
builder
:
Builder
)
=>
SchemaNode
)
=>
SchemaNode
;
Error
:
typeof
SchemaError
;
Node
:
typeof
SchemaNode
;
NullableSchema
:
typeof
NullableSchema
;
ObjectBuilder
:
typeof
ObjectBuilder
;
ObjectSchema
:
typeof
ObjectSchema
;
OptionalSchema
:
typeof
OptionalSchema
;
PATH_ROOT
:
string
;
Result
:
typeof
SchemaResult
;
ScalarSchema
:
typeof
ScalarSchema
;
}
AnySchema
:
typeof
AnySchema
ArrayBuilder
:
typeof
ArrayBuilder
ArraySchema
:
typeof
ArraySchema
Builder
:
typeof
Builder
define
:
(
block
:
(
builder
:
Builder
)
=>
SchemaNode
)
=>
SchemaNode
Error
:
typeof
SchemaError
Node
:
typeof
SchemaNode
NullableSchema
:
typeof
NullableSchema
ObjectBuilder
:
typeof
ObjectBuilder
ObjectSchema
:
typeof
ObjectSchema
OptionalSchema
:
typeof
OptionalSchema
PATH_ROOT
:
string
CTON Schema - Validation DSL for CTON data
Result
:
typeof
SchemaResult
ScalarSchema
:
typeof
ScalarSchema
stats
:
(
data
:
unknown
)
=>
Stats
Stats
:
typeof
Stats
statsHash
:
(
data
:
unknown
)
=>
StatsJSON
StreamReader
:
typeof
StreamReader
StreamWriter
:
typeof
StreamWriter
typeRegistry
:
TypeRegistry
TypeRegistry
:
typeof
TypeRegistry
unregisterType
:
<
T
>
(
ctor
:
new
(
...
args
:
any
[]
)
=>
T
)
=>
void
validate
:
(
ctonString
:
string
)
=>
ValidationResult
validateSchema
:
(
data
:
unknown
,
schemaDef
:
SchemaNode
)
=>
SchemaResult
ValidationError
:
typeof
ValidationError
ValidationResult
:
typeof
ValidationResult
Validator
:
typeof
Validator
VERSION
:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
cton-js
Loading...
Alias for dump