PlatformPlugin
PlatformPlugin:
object
Defined in: packages/core/src/plugin.ts:142
Companion object for the PlatformPlugin type. Provides factory and type guard utilities.
Type Declaration
Section titled “Type Declaration”create()
Section titled “create()”
readonlycreate(definition,methods):PlatformPlugin
Create a PlatformPlugin from a declarative definition and methods.
Parameters
Section titled “Parameters”definition
Section titled “definition”declarative plugin configuration
methods
Section titled “methods”platform-specific data access implementations
Returns
Section titled “Returns”a fully wired PlatformPlugin
Precondition
Section titled “Precondition”definition.rateLimitStrategy is initialized
Postcondition
Section titled “Postcondition”returns a fully functional PlatformPlugin with wired RestManager
readonlyis(value):value is PlatformPlugin
Type guard for PlatformPlugin.
Parameters
Section titled “Parameters”unknown
the value to check
Returns
Section titled “Returns”value is PlatformPlugin
true if value implements PlatformPlugin
Postcondition
Section titled “Postcondition”returns true if value has all required PlatformPlugin properties
Example
Section titled “Example”const plugin = PlatformPlugin.create(definition, methods);if (PlatformPlugin.is(unknown)) { ... }