workflow.profilehandler.md

January 18, 2023 ยท View on GitHub

Home > @datashaper/workflow > ProfileHandler

ProfileHandler interface

A custom profile handler

Signature:

export interface ProfileHandler<Res extends Resource = Resource, Schema extends ResourceSchema = ResourceSchema, InitializationContext extends ProfileInitializationContext = ProfileInitializationContext> 

Properties

PropertyModifiersTypeDescription
initialize?(ctx: InitializationContext) => void(Optional) Initialize the profile handler
profileProfileThe profile name of the resource
save?(data: Res, path: string, files: Map<string, Blob>) => Promise<string[]>(Optional) Save custom resources into the files map.

Methods

MethodDescription
createInstance(schema)Creates a new instance of a schema resource