diff --git a/.changeset/unlucky-rocks-perform.md b/.changeset/unlucky-rocks-perform.md new file mode 100644 index 0000000000..25ff98e2dc --- /dev/null +++ b/.changeset/unlucky-rocks-perform.md @@ -0,0 +1,5 @@ +--- +"effect": patch +--- + +fix jsdoc for Inspectable.format diff --git a/docs/modules/Inspectable.ts.md b/docs/modules/Inspectable.ts.md index 285d0dbb3b..bccf5e20b6 100644 --- a/docs/modules/Inspectable.ts.md +++ b/docs/modules/Inspectable.ts.md @@ -18,6 +18,7 @@ Added in v2.0.0 - [NodeInspectSymbol](#nodeinspectsymbol) - [NodeInspectSymbol (type alias)](#nodeinspectsymbol-type-alias) - [utils](#utils) + - [format](#format) - [toJSON](#tojson) --- @@ -62,6 +63,16 @@ Added in v2.0.0 # utils +## format + +**Signature** + +```ts +export declare const format: (x: unknown) => string +``` + +Added in v2.0.0 + ## toJSON **Signature** diff --git a/src/Inspectable.ts b/src/Inspectable.ts index 32fcf0ff28..7536f1a333 100644 --- a/src/Inspectable.ts +++ b/src/Inspectable.ts @@ -41,5 +41,7 @@ export const toJSON = (x: unknown): unknown => { return x } -/** @internal */ +/** + * @since 2.0.0 + */ export const format = (x: unknown): string => JSON.stringify(x, null, 2)