deprecate-api

Installation
SKILL.md

API deprecations in Remotion

Deprecation of a public API that remains available is represented in three places:

  1. A JSDoc @deprecated annotation on the public TypeScript API.
  2. Strikethrough formatting on the API's documentation heading.
  3. An info admonition named Deprecated directly after that heading.

These conventions apply to functions, components, hooks, types, props, options, and other public APIs.

TypeScript representation

The public symbol carries a JSDoc @deprecated annotation. The annotation states the replacement when one exists and may link to its documentation.

Installs
32
GitHub Stars
55.4K
First Seen
5 days ago
deprecate-api — remotion-dev/remotion