Search
Preparing search index...
The search index is not available
Prudence JavaScript and TypeScript APIs
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Prudence JavaScript and TypeScript APIs
prudence
Namespace prudence
Index
Classes
Distributed
Cache
Facet
Local
Scheduler
Map
Cache
Memory
Cache
Representation
Resource
Route
Router
Server
Static
Tiered
Cache
Interfaces
Cache
Backend
Handler
Scheduler
Startable
Type Aliases
Facet
Config
Handle
Function
Representation
Config
Representation
Hook
Route
Config
Variables
data
Content
Types
Functions
invalidate
Cache
Group
not
Found
redirect
Trailing
Slash
schedule
set
Cache
set
Scheduler
start
Type Aliases
Facet
Config
Facet
Config
:
{
name
?:
string
;
paths
?:
string
|
string
[]
;
redirectTrailingSlashStatus
?:
number
;
representations
?:
RepresentationConfig
|
RepresentationConfig
[]
;
variables
?:
{}
}
Type declaration
Optional
name
?:
string
Optional
paths
?:
string
|
string
[]
Optional
redirect
Trailing
Slash
Status
?:
number
Optional
representations
?:
RepresentationConfig
|
RepresentationConfig
[]
Optional
variables
?:
{}
[
key:
string
]:
any
Handle
Function
Handle
Function
:
(
(
)
=>
boolean
)
Type declaration
(
)
:
boolean
Returns
boolean
Representation
Config
Representation
Config
:
{
call
?:
RepresentationHook
;
charSet
?:
string
;
contentTypes
?:
string
|
string
[]
;
describe
?:
RepresentationHook
;
erase
?:
RepresentationHook
;
hooks
?:
{
call
?:
RepresentationHook
;
describe
?:
RepresentationHook
;
erase
?:
RepresentationHook
;
modify
?:
RepresentationHook
;
prepare
?:
RepresentationHook
;
present
?:
RepresentationHook
}
;
languages
?:
string
|
string
[]
;
modify
?:
RepresentationHook
;
name
?:
string
;
prepare
?:
RepresentationHook
;
present
?:
RepresentationHook
;
redirectTrailingSlash
?:
boolean
;
redirectTrailingSlashStatus
?:
number
;
variables
?:
{}
}
Type declaration
Optional
call
?:
RepresentationHook
Optional
char
Set
?:
string
Optional
content
Types
?:
string
|
string
[]
Optional
describe
?:
RepresentationHook
Optional
erase
?:
RepresentationHook
Optional
hooks
?:
{
call
?:
RepresentationHook
;
describe
?:
RepresentationHook
;
erase
?:
RepresentationHook
;
modify
?:
RepresentationHook
;
prepare
?:
RepresentationHook
;
present
?:
RepresentationHook
}
Optional
call
?:
RepresentationHook
Optional
describe
?:
RepresentationHook
Optional
erase
?:
RepresentationHook
Optional
modify
?:
RepresentationHook
Optional
prepare
?:
RepresentationHook
Optional
present
?:
RepresentationHook
Optional
languages
?:
string
|
string
[]
Optional
modify
?:
RepresentationHook
Optional
name
?:
string
Optional
prepare
?:
RepresentationHook
Optional
present
?:
RepresentationHook
Optional
redirect
Trailing
Slash
?:
boolean
Optional
redirect
Trailing
Slash
Status
?:
number
Optional
variables
?:
{}
[
key:
string
]:
any
Representation
Hook
Representation
Hook
:
(
(
)
=>
void
)
Type declaration
(
)
:
void
Returns
void
Route
Config
Route
Config
:
{
handler
?:
Handler
|
HandleFunction
;
name
?:
string
;
paths
?:
string
|
string
[]
;
redirectTrailingSlashStatus
?:
number
;
variables
?:
{}
}
Type declaration
Optional
handler
?:
Handler
|
HandleFunction
Optional
name
?:
string
Optional
paths
?:
string
|
string
[]
Optional
redirect
Trailing
Slash
Status
?:
number
Optional
variables
?:
{}
[
key:
string
]:
any
Variables
Const
data
Content
Types
data
Content
Types
:
string
[]
Functions
invalidate
Cache
Group
invalidate
Cache
Group
(
group
:
string
)
:
void
Parameters
group:
string
Returns
void
not
Found
not
Found
(
)
:
boolean
Returns
boolean
redirect
Trailing
Slash
redirect
Trailing
Slash
(
)
:
boolean
Returns
boolean
schedule
schedule
(
cronPattern
:
string
, f
:
(
(
)
=>
void
)
)
:
void
Parameters
cronPattern:
string
f:
(
(
)
=>
void
)
(
)
:
void
Returns
void
Returns
void
set
Cache
set
Cache
(
backend
:
CacheBackend
)
:
void
Parameters
backend:
CacheBackend
Returns
void
set
Scheduler
set
Scheduler
(
scheduler
:
Scheduler
)
:
void
Parameters
scheduler:
Scheduler
Returns
void
start
start
(
startables
:
Startable
|
Startable
[]
)
:
void
Parameters
startables:
Startable
|
Startable
[]
Returns
void
Exports
ard
env
os
prudence
scriptlet
transcribe
util
Distributed
Cache
Facet
Local
Scheduler
Map
Cache
Memory
Cache
Representation
Resource
Route
Router
Server
Static
Tiered
Cache
Cache
Backend
Handler
Scheduler
Startable
Facet
Config
Handle
Function
Representation
Config
Representation
Hook
Route
Config
data
Content
Types
invalidate
Cache
Group
not
Found
redirect
Trailing
Slash
schedule
set
Cache
set
Scheduler
start
Generated using
TypeDoc