Preparing search index...
The search index is not available
The Extollo Framework
The Extollo Framework
encode
Function encode
encode
<
T
>
(
value
:
T
)
:
Promise
<
string
>
Encode a value to JSON using a registered serializer.
Throws
NoSerializerError
Type Parameters
T
Parameters
value:
T
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
The
Extollo
Framework
Getting
Started
About
Extollo
api
Constraint
Type
Field
Type
Grant
Type
HTTPStatus
Logging
Level
OAuth2
Flow
Type
Unit
Status
Abstract
Builder
Abstract
Factory
Abstract
Resolved
Route
HandlerHTTPModule
Abstract
Result
Iterable
Access
Global
Registry
Outside
Async
Lifecycle
Error
Activated
Route
Active
Scope
App
Class
Application
Applied
Migration
Event
Applying
Migration
Event
Array
Iterable
Async
Collection
Async
Pipe
Auth
Check
Failed
Auth
Check
Failed
Serializer
Auth
Required
Middleware
Authenticatable
Authenticatable
Already
Exists
Error
Authenticatable
Repository
Authenticatable
Repository
Factory
Authentication
Authentication
Event
Authentication
Event
Serializer
Base
Event
Base
Job
Base
Serializer
Basic
Login
Provider
Behavior
Subject
Builder
Bus
CLIOption
Cache
Cache
Factory
Cache
Model
Cache
Queue
Cache
Redemption
Code
Repository
Cache
Session
Canon
Canonical
Canonical
Instantiable
Canonical
Item
Class
Canonical
Recursive
Canonical
Static
Clear
Request
Event
BusHTTPModule
Client
Repository
Client
Repository
Factory
Closure
Factory
Collection
Column
Builder
Command
Line
Command
Line
Application
Completed
Observable
Error
Config
Config
Client
Repository
Config
Scope
Repository
Connection
Connection
Not
Ready
Error
Constraint
Builder
Container
Container
Blueprint
Controller
Controllers
CoreIDLogin
Provider
Create
Migration
Directive
Database
Database
Migrator
Database
Service
Debugging
Trace
Is
Not
An
Error
Dehydrated
State
Response
Factory
Directive
Discovery
Duplicate
Factory
Key
Error
Duplicate
Resolver
Key
Error
Error
Response
Factory
Error
With
Context
Execute
Resolved
Route
HandlerHTTPModule
Execute
Resolved
Route
PostflightHTTPModule
Execute
Resolved
Route
PreflightHTTPModule
Factory
Fake
Canonical
File
Logger
File
Not
Found
Error
File
Response
Factory
Files
Filesystem
Filesystem
Does
Not
Exist
Filesystem
Operation
Not
Supported
Flag
Option
Foreground
Global
Registry
Guest
Required
Middleware
HTMLResponse
Factory
HTTPCookie
Jar
HTTPError
HTTPError
Response
Factory
HTTPFilesystem
HTTPKernel
HTTPKernel
Module
HTTPServer
Has
Many
Has
One
Has
One
Or
Many
Has
Subtree
Has
Tree
Parent
Headers
Already
Sent
Error
In
Mem
Cache
Index
Builder
Inject
Request
Locale
Inject
SessionHTTPModule
Injection
Aware
Internationalization
Invalid
Canonical
Export
Error
Invalid
Dependency
Key
Error
InvalidJSONState
Error
Invalid
Out
Of
Request
Access
Error
Invalid
Schema
Mapping
Error
Iterable
JSONMessage
Event
JSONMessage
Event
Serializer
JSONResponse
Factory
Listen
Directive
Local
Bus
Local
Filesystem
Locale
Logger
Logging
Memory
Cache
Memory
Session
Messages
Method
Not
Supported
Error
Middleware
Middlewares
Migrate
Directive
Migration
Migration
Event
Migrations
Migrator
Migrator
Factory
Model
Model
Builder
Model
Result
Iterable
Model
Serializer
Models
Mount
Activated
RouteHTTPModule
Named
Event
Payload
Named
Event
Payload
Serializer
No
Serializer
Error
No
Session
Key
Error
No
Such
Canonical
Resolver
Key
Error
Node
Modules
Not
Authorized
Error
Nothing
To
Migrate
Error
OAuth2
Login
Provider
OAuth2
Server
OAuth2
Token
OAuth2
Token
Model
ORMCache
ORMSession
ORMToken
Repository
ORMUser
ORMUser
Repository
Option
Validation
Error
Parameter
Middleware
Persist
SessionHTTPModule
Pipeline
Positional
Option
PostgreSQLDialect
Postgres
Connection
Postgres
Schema
Powered
By
Header
InjectionHTTPModule
Pug
View
Engine
Pushed
To
Queue
Pushing
To
Queue
Query
Executed
Event
Query
Executed
Event
Serializer
Query
Safe
Value
Queue
Queue
Event
Serializer
Queue
Factory
Queueables
Read
Only
Filesystem
Redemption
Code
Repository
Redemption
Code
Repository
Factory
Redirect
Response
Factory
Redis
Redis
Bus
Redis
Cache
Relation
Relation
Builder
Relation
Not
Loaded
Error
Request
Request
Local
Storage
Response
Response
Already
Sent
Error
Response
Factory
Result
Collection
Result
Iterable
Rollback
Directive
Rolled
Back
Migration
Event
Rolling
Back
Migration
Event
Route
Route
Group
Route
Response
Factory
Routing
Run
Level
Error
Handler
SQLDialect
SQLite
Connection
SQLite
Dialect
SQLite
Schema
SSHFilesystem
Safe
Schema
Schema
Builder
Base
Scope
Scope
Repository
Scope
Repository
Factory
Scope
Required
Middleware
Scoped
Container
Security
Context
Serialization
Session
Session
Auth
Middleware
Session
Factory
Session
Model
Session
Not
Loaded
Error
Session
Security
Context
Set
Session
CookieHTTPModule
Shell
Directive
Simple
Canonical
Item
Serializer
Socket
Route
Builder
Standard
Logger
State
Event
State
Event
Serializer
Static
ServerHTTPError
Stop
Iteration
String
Response
Factory
Sync
Queue
Table
Builder
Template
Directive
Temporary
Redirect
Response
Factory
Token
Auth
Middleware
Token
Repository
Token
Repository
Factory
Token
Security
Context
Tree
Model
Unit
Universal
Path
Unsubscribe
Error
Usage
Directive
User
Authenticated
Event
User
Authentication
Resumed
Event
User
Flushed
Event
Validation
Error
Validation
Unit
Validator
View
Engine
View
Engine
Factory
View
Response
Factory
Web
Socket
Bus
Web
Socket
Close
Event
Web
Socket
Health
Check
Event
Websocket
Server
Work
Directive
Zodify
Registrar
Authentication
Config
Authentication
Event
Serial
Payload
Aware
Of
Container
Lifecycle
Bindable
Bus
Internal
Subscription
Bus
Queue
Bus
Subscriber
Canonical
Definition
Canonical
Receiver
Canonical
Reference
Complex
Canonical
Resolver
Constraint
Group
Constraint
Item
Data
Container
Dependency
Requirement
Event
Event
Bus
Event
Handler
Subscription
File
Metadata
HTTPCookie
HTTPCookie
Options
HTTPProtocol
HTTPSource
Address
Handled
Route
In
Mem
Cache
Item
Injection
Type
Instance
Ref
Instantiable
Local
Filesystem
Config
Log
Message
Model
Field
Model
Serial
Payload
Module
Registration
Fluency
OAuth2
Client
OAuth2
Login
Provider
Config
OAuth2
Redemption
Code
OAuth2
Scope
Postgres
Connection
Config
Property
Dependency
Query
Executed
Event
Serial
Payload
Query
Result
Queue
Config
Queue
Event
Serial
Payload
Queueable
Redis
Bus
Connector
Config
Redis
Options
Rehydratable
SQLite
Connection
Config
Serial
Payload
Serializer
Simple
Canonical
Item
Serial
State
Stat
Static
Server
Options
Template
Timeout
Subscriber
Type
Tag
Validation
Form
Errors
Zodify
Recipient
Array
Element
Associated
Collection
Item
Associated
Search
Item
Async
Pipe
Condition
Async
Pipe
Operator
Async
Pipe
Resolver
Authenticatable
Identifier
Awaitable
Awaited
Basic
Login
Attempt
Basic
Registration
Attempt
Bus
Connector
Config
Canonical
Resolver
Canonical
Resolver
Function
Chunk
Callback
Collectable
Collection
Comparable
Collection
Function
Collection
Index
Collection
Item
Comparison
Function
Complex
Subscriber
Constraint
Constraint
Connection
Operator
Constraint
Group
Closure
Constraint
Operator
Constructable
Constructor
Container
Resolution
Callback
Dependency
Key
Determines
Equality
Either
Escape
Value
Escape
Value
Object
Event
Handler
Event
Handler
Return
Global
Registrant
HTTPMethod
Handler
Param
Providers
Integer
JSONState
Key
Function
Key
Operator
Key
Reducer
Function
Key
Value
Left
Locale
Helper
Maybe
Maybe
Arr
Maybe
Collection
Index
Maybe
Collection
Item
Maybe
Dependency
Maybe
Factory
MaybeHTTPCookie
Maybe
Iteration
Item
Method
Type
Methods
Of
Model
Key
Model
Keys
OAuth2
Token
String
Option
Definition
Order
Direction
Order
Statement
Parameter
Providing
Middleware
Parameterized
Callback
Path
Like
Pipe
Condition
Pipe
Operator
Prefix
Type
Array
Promise
Pipe
Operator
Query
Row
Query
Source
Queue
Event
Reflexive
Async
Pipe
Operator
Reflexive
Pipe
Operator
Relation
Value
Resolved
Dependency
Resolved
Route
Handler
Response
Object
Right
Scalar
Escape
Value
Scope
Closure
Serialized
State
Event
Session
Data
Should
Queue
Socket
Event
Handler
Specified
Field
Static
Class
Static
Instantiable
Subscriber
Complete
Function
Subscriber
Error
Function
Subscriber
Function
Subscription
Suffix
Type
Array
Type
Array
Signature
Typed
Dependency
Key
Unsubscribe
Valid
Validator
Factory
Vector
Escape
Value
Where
Operator
Where
Result
Basic
Login
Attempt
Type
Basic
Registration
Attempt
Type
DEPENDENCY_
KEYS_
METADATA_
KEY
DEPENDENCY_
KEYS_
PROPERTY_
METADATA_
KEY
DEPENDENCY_
KEYS_
SERVICE_
TYPE_
KEY
EXTOLLO_
AUTH_
SESSION_
KEY
EXTOLLO_
ORM_
MODEL_
FIELDS_
METADATA_
KEY
HTTPMessage
Model
Events
global
Registry
grant
Types
CLIDirective
Factory
Producer
Field
Inject
Inject
Param
Injectable
Object
Serializer
Related
Singleton
app
Path
apply
Mixins
apply
Where
base
Path
bytes
To
Human
File
Size
collect
constructable
data
Get
Unsafe
data
Set
Unsafe
data
Walk
Unsafe
decode
deep
Copy
dehydrate
encode
env
error
fetch
file
get
Fields
Meta
get
Property
Injection
Metadata
has
Own
Property
html
http
if
Debugging
infer
inverse
Field
Type
is
Authentication
Config
is
Aware
Of
Container
Lifecycle
is
Bindable
is
Canonical
Receiver
is
Constraint
Group
is
Constraint
Item
is
Debugging
isHTTPMethod
is
Instantiable
is
Instantiable
Of
is
Integer
isJSON
isJSONState
is
Keyof
is
Left
is
Log
Message
is
Logging
Level
isOAuth2
Client
isOAuth2
Flow
Type
isOAuth2
Redemption
Code
isOAuth2
Scope
isOAuth2
Token
is
Right
is
Serialized
State
Event
is
Static
Class
json
left
lib
log
If
Debugging
make
oauth2
Token
String
object
To
Key
Value
pad
Center
pad
Left
pad
Right
plaintext
raw
redirect
redirect
To
Get
register
Zodified
Schema
right
route
scope
set
Fields
Meta
should
Queue
static
Server
string
To
Pascal
tap
temporary
to
String
uninfer
universal
Path
unleft
unright
uuid4
view
walk
web
Socket
Auth
Check
where
Match
with
Error
Context
with
Timeout
Encode a value to JSON using a registered serializer.
Throws
NoSerializerError