Search
Preparing search index...
The search index is not available
Soukai API
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Soukai API
EngineHelper
Class EngineHelper
Hierarchy
EngineHelper
Index
Constructors
constructor
Methods
filter
Documents
obtain
Document
Id
update
Attributes
Constructors
constructor
new
Engine
Helper
(
)
:
EngineHelper
Returns
EngineHelper
Methods
filter
Documents
filter
Documents
(
documents
:
EngineDocumentsCollection
, filters
?:
EngineFilters
)
:
EngineDocumentsCollection
Parameters
documents:
EngineDocumentsCollection
filters:
EngineFilters
= {}
Returns
EngineDocumentsCollection
obtain
Document
Id
obtain
Document
Id
(
id
?:
string
)
:
string
Parameters
Optional
id:
string
Returns
string
update
Attributes
update
Attributes
(
attributes
:
Record
<
string
,
EngineAttributeValue
>
, updates
:
EngineUpdates
)
:
void
Parameters
attributes:
Record
<
string
,
EngineAttributeValue
>
updates:
EngineUpdates
Returns
void
Exports
Engine
Helper
constructor
filter
Documents
obtain
Document
Id
update
Attributes
Generated using
TypeDoc