Skip to content

fix: reposition orphaned JSDoc blocks in type-system.ts #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feffef merged 1 commit into from
Apr 17, 2026
Merged

fix: reposition orphaned JSDoc blocks in type-system.ts #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions src/type-system.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,18 @@ export interface Navigable<L extends Record<string, LinkSpec>> {
[$links]: L;
}

/**
* Controls how much detail the library includes in error messages.
*
* - `'verbose'` (default): includes full URL, resource names, schema paths — best for client-side debugging.
* - `'safe'`: omits URLs and internal identifiers — use in BFF/API gateway contexts.
*
* Single source of truth for the verbosity union — every internal helper that
* branches on verbosity (`api-client`, `error-handling`, `uri-templates`)
* imports this alias rather than restating the literal union.
*/
export type Verbosity = 'verbose' | 'safe';

/**
* Configuration options for connecting to a hypermedia API.
*
Expand All @@ -121,18 +133,6 @@ export interface Navigable<L extends Record<string, LinkSpec>> {
* });
* ```
*/
/**
* Controls how much detail the library includes in error messages.
*
* - `'verbose'` (default): includes full URL, resource names, schema paths — best for client-side debugging.
* - `'safe'`: omits URLs and internal identifiers — use in BFF/API gateway contexts.
*
* Single source of truth for the verbosity union — every internal helper that
* branches on verbosity (`api-client`, `error-handling`, `uri-templates`)
* imports this alias rather than restating the literal union.
*/
export type Verbosity = 'verbose' | 'safe';

export interface ConnectOptions<
ApiDef extends ApiDefinition,
RootResource extends ResourceNameFrom<ApiDef> = ResourceNameFrom<ApiDef>
Expand Down Expand Up @@ -314,8 +314,7 @@ type Merge<S, O> = MergeInner<S, NonNullable<O>>;
* Non-Navigable overlays (intermediate path segments) add `& unknown`
* which TypeScript simplifies away.
* - Primitives: Simple intersection S & O
*/
/**
*
* @internal Exported solely for type-level test access in `test/unit/type-system.test.ts`.
* Not intended for public consumption — consume `Resource<N, A>` instead.
*/
Expand Down
Loading