skills.rest
umbraco
umbracoOFFICIAL
Explore all skills by this author →
WebsiteGitHub

general-deprecate-api

Deprecate public API elements with runtime warnings and versioning policies.

5.2k|2.9k|Updated Jun 10, 2013
Search Tags:#typescript#versioning#api#deprecation#runtime warning
One-click install
npx skills add https://github.com/umbraco/Umbraco-CMS --skill general-deprecate-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: general-deprecate-api
Source: https://github.com/umbraco/Umbraco-CMS/tree/main/src/Umbraco.Web.UI.Client/.claude/skills/general-deprecate-api
Command: npx skills add https://github.com/umbraco/Umbraco-CMS --skill general-deprecate-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Developers need to deprecate public APIs systematically to ensure smooth transitions and avoid breaking changes during software updates.

Core Features & Use Cases

  • Deprecation Guidance: Provides step-by-step instructions for deprecating APIs following best practices.
  • Automated Warnings: Implements runtime warnings to alert when deprecated members are invoked.
  • Use Case: Easily deprecate a class or method across a codebase, ensuring compliance with versioning policies while informing consumers.

Quick Start

Use this Skill to add deprecation warnings to a public method and guide users towards the new API.

Frequently Asked Questions about general-deprecate-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deprecate a public API method in TypeScript without causing breaking changes?▼

To deprecate a public API method in TypeScript without breaking changes, apply structured deprecation instructions and implement runtime warnings to alert consumers while providing guidance towards the new API.

What is the best way to alert users when deprecated API members are invoked?▼

The best way to alert users when deprecated API members are invoked is by implementing automated runtime warnings that systematically inform consumers during software updates.

How does API deprecation work with versioning policies in a software repository?▼

API deprecation works with versioning policies by systematically guiding the transition of public elements, ensuring compliance with software versioning standards while updating internal codebases.

Do I need to know TypeScript to implement API deprecation warnings?▼

Yes, you need knowledge of TypeScript and software versioning standards to implement API deprecation warnings and manage internal code updates effectively.

When should I use runtime warnings for API deprecation in my codebase?▼

You should use runtime warnings for API deprecation when you need to facilitate smooth transitions and alert consumers that deprecated classes, methods, or properties are being invoked.

Related Skills

Explore More Software Engineering Skills→
SSiertsemaSSiertsema

api-versioning-strategy

Define API versioning strategies for REST, GraphQL, gRPC, and event streams.

Community
Advanced
seydakaratekeliseydakaratekeli

maui-current-apis

Detect deprecated .NET MAUI APIs in project source code.

Community
Advanced
kayamankayaman
1

semver

Validate and enforce SemVer 2.0.0 version bumps and formatting for releases.

Community
Intermediate
deckgl-fiber-rendererdeckgl-fiber-renderer
17

accelint-ts-documentation

Audit JavaScript/TypeScript documentation and generate fixes for JSDoc tags and code-quality markers.

Official
Advanced