Function fireworks

fireworks(idOrOptions?, sourceOptions?): Promise<FireworksInstance | undefined>
Parameters
- OptionalidOrOptions: string | RecursivePartial<IFireworkOptions>
  the id used for displaying the animation, or the animation configuration if an id is not necessary
- OptionalsourceOptions: RecursivePartial<IFireworkOptions>
  the animation configuration if an id is provided
Returns Promise<FireworksInstance | undefined>
the loaded instance
- Defined in bundles/fireworks/src/fireworks.ts:358

Index

Properties

Methods

Properties

version

version: string

Methods

create

create(canvas, options?): Promise<undefined | FireworksInstance>
Parameters
- canvas: HTMLCanvasElement
- Optionaloptions: RecursivePartial<IFireworkOptions>
Returns Promise<undefined | FireworksInstance>
- Defined in bundles/fireworks/src/fireworks.ts:376

init

init(): Promise<void>
Returns Promise<void>
- Defined in bundles/fireworks/src/fireworks.ts:385