|
| 1 | +# @objectstack/spec — the .d.ts DECLARATION TEXT of every export of `./meta-spelling`. |
| 2 | +# |
| 3 | +# The SHAPE half of the ADR-0059 public-API pin, and the readable counterpart of |
| 4 | +# api-surface/meta-spelling.json's breadth half. That file pins each export by |
| 5 | +# `name (kind)`, which a signature change, a renamed interface field and a dropped |
| 6 | +# union member all leave untouched. This file pins the declaration text, so each of |
| 7 | +# those moves a line here. Text and NOT a hash, deliberately: a diff a reviewer can |
| 8 | +# read is what makes contract review a guard rather than a rubber stamp. |
| 9 | +# |
| 10 | +# Verbatim from the PACKED `.d.ts` reached through this package's `exports` map — the |
| 11 | +# declarations a consumer installs, never `src/`. A declaration's leading TSDoc is |
| 12 | +# excluded: documentation drift is `check:docs`'s axis, not this one. |
| 13 | +# |
| 14 | +# entry: ./meta-spelling |
| 15 | +# exported names: 8 |
| 16 | +# declarations: 8 |
| 17 | +# |
| 18 | +# GENERATED — ⛔ never hand-edited. Regenerate after a real build: |
| 19 | +# pnpm --filter @objectstack/spec build && pnpm --filter @objectstack/spec gen:api-surface-declarations |
| 20 | +# Gated by `check:api-surface-declarations`; a hand edit is a red gate, not a change. |
| 21 | + |
| 22 | +// ── META_URL_TO_SINGULAR (const) ── |
| 23 | +declare const META_URL_TO_SINGULAR: Readonly<Record<string, string>>; |
| 24 | + |
| 25 | +// ── PLURAL_TO_SINGULAR (const) ── |
| 26 | +declare const PLURAL_TO_SINGULAR: Record<string, string>; |
| 27 | + |
| 28 | +// ── SINGULAR_TO_PLURAL (const) ── |
| 29 | +declare const SINGULAR_TO_PLURAL: Record<string, string>; |
| 30 | + |
| 31 | +// ── canonicalMetaUrlType (function) ── |
| 32 | +declare function canonicalMetaUrlType(type: string): string; |
| 33 | + |
| 34 | +// ── metaUrlSpellingRefusal (function) ── |
| 35 | +declare function metaUrlSpellingRefusal(urlType: string): { |
| 36 | + declared: string; |
| 37 | + hint: string; |
| 38 | +} | null; |
| 39 | + |
| 40 | +// ── pluralToSingular (function) ── |
| 41 | +declare function pluralToSingular(key: string): string; |
| 42 | + |
| 43 | +// ── singularToPlural (function) ── |
| 44 | +declare function singularToPlural(key: string): string; |
| 45 | + |
| 46 | +// ── unrecognisedMetaTypeRefusal (function) ── |
| 47 | +declare function unrecognisedMetaTypeRefusal(urlType: string): { |
| 48 | + type: string; |
| 49 | +} | null; |
0 commit comments