deprecate-api
Installation
SKILL.md
API deprecations in Remotion
Deprecation of a public API that remains available is represented in three places:
- A JSDoc
@deprecatedannotation on the public TypeScript API. - Strikethrough formatting on the API's documentation heading.
- An
infoadmonition namedDeprecateddirectly 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.