Skip to content

Upgrading @takumi-rs/core 0.70 to 0.71

Breaking0.70.4 → 0.71.7Breaking1New1Changed3

Full comparisonBack to @takumi-rs/core
BreakingUpgrade verdict

1 breaking change.

In plain terms
  • BREAKING CHANGE: renderAnimation now take "scenes" with keyframe animations instead of frames.
Must act 1 item needs code or config changes

What you must change

Breaking1
BREAKING CHANGE: renderAnimation now take "scenes" with keyframe animations instead of frames.
renderAnimationencodeFrames
0.71.0GitHub ReleaseOriginalView source

API changes

Generated by DepDelta from published .d.ts files. Not mixed with prose notes.

  • changed: method Renderer.renderAnimation(source: AnimationFrameSource[], options: RenderAnimationOptions, signal?: AbortSignal): Promise<Buffer> → method Renderer.renderAnimation(options: RenderAnimationOptions, signal?: AbortSignal): Promise<Buffer>
  • changed: type AnimationOutputFormat = 'webp'| 'apng' → type AnimationOutputFormat = 'webp'| 'apng'| 'gif'
  • added: interface AnimationSceneSource
  • added: interface EncodeFramesOptions
  • added: method Renderer.encodeFrames(source: AnimationFrameSource[], options: EncodeFramesOptions, signal?: AbortSignal): Promise<Buffer>
  • added: property AnimationSceneSource.durationMs: number
  • added: property AnimationSceneSource.node: AnyNode
  • added: property EncodeFramesOptions.devicePixelRatio?: number
  • added: property EncodeFramesOptions.drawDebugBorder?: boolean
  • added: property EncodeFramesOptions.fetchedResources?: Array<ImageSource>
  • added: property EncodeFramesOptions.format?: AnimationOutputFormat
  • added: property EncodeFramesOptions.height: number
  • added: property EncodeFramesOptions.quality?: number
  • added: property EncodeFramesOptions.stylesheets?: Array<string>
  • added: property EncodeFramesOptions.width: number
  • added: property RenderAnimationOptions.devicePixelRatio?: number
  • added: property RenderAnimationOptions.fetchedResources?: Array<ImageSource>
  • added: property RenderAnimationOptions.fps: number
  • added: property RenderAnimationOptions.quality?: number
  • added: property RenderAnimationOptions.scenes: Array<AnimationSceneSource>
  • added: property RenderAnimationOptions.stylesheets?: Array<string>
  • added: property RenderOptions.dithering?: DitheringAlgorithm
  • added: property RenderOptions.keyframes?: { name: string; keyframes: { offsets: number[]; declarations: Record<string, unknown> }[] }[] | Keyframes
  • added: property RenderOptions.timeMs?: number
  • added: type DitheringAlgorithm = 'None'| 'ordered-bayer'| 'floyd-steinberg'
  • added: type Keyframes = Record<string, Record<string, Record<string, unknown>>>