unstableApiUsage

Warns when using an API marked @stability unstable

Property	Value
Category	Correctness
Default severity	warning
Fixable	No
Effect versions	v4
Diagnostic codes	TS377136
Language Service name	unstableApiUsage
Oxlint name	effecttsgo/unstable-api-usage

Preview

/** @stability unstable */
export const previewApi = () => 1

previewApi()
/**
^^^^^^^^^^ effecttsgo(unstable-api-usage): `effect-v4-tests/preview#previewApi` is an unstable API. Breaking changes may happen between versions.
*/

Language Service Configuration

See the Language Service setup guide for installation instructions.

{
  "$schema": "./node_modules/@effect/tsgo/schema.json",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@effect/language-service",
        "diagnosticSeverity": {
          "unstableApiUsage": "warning"
        }
      }
    ]
  }
}

Oxlint Configuration

See the Oxlint setup guide for installation and patching instructions.

{
  "$schema": "./node_modules/@effect/tsgo/oxlint-schema.json",
  "options": {
    "typeAware": true
  },
  "plugins": ["effecttsgo"],
  "rules": {
    "effecttsgo/unstable-api-usage": "warn"
  }
}