@unthrown/pattern 0.3.0 → 1.0.0

package/README.md

@@ -19,18 +19,18 @@ import { match } from "ts-pattern";
 import * as P from "@unthrown/pattern";
 
 match(result)
-  .with(P.ok(), ({ value }) => `ok: ${value}`)
-  .with(P.err(P.tag("Forbidden")), ({ error }) => `403 ${error.user}`)
-  .with(P.err(), () => "error")
-  .with(P.defect(), () => "bug")
+  .with(P.Ok(), ({ value }) => `ok: ${value}`)
+  .with(P.Err(P.tag("Forbidden")), ({ error }) => `403 ${error.user}`)
+  .with(P.Err(), () => "error")
+  .with(P.Defect(), () => "bug")
   .exhaustive();
 ```
 
-- `P.ok(sub?)` / `P.err(sub?)` / `P.defect(sub?)` — match a channel; pass a
+- `P.Ok(sub?)` / `P.Err(sub?)` / `P.Defect(sub?)` — match a channel; pass a
   sub-pattern to constrain or select the payload: a literal, or any `ts-pattern`
   pattern (e.g. `ts-pattern`'s own `P.string` / `P.select()`, imported from
   `ts-pattern`). (Or skip the sugar and match `{ tag: "Ok", … }` directly.)
-- `P.tag(t)` — sugar for `{ _tag: t }`; nested in `P.err(...)` it narrows to the
+- `P.tag(t)` — sugar for `{ _tag: t }`; nested in `P.Err(...)` it narrows to the
   matching `TaggedError` variant, including its payload.
 
 For the everyday exhaustive case, `matchTags` in core is simpler. Reach for this

package/dist/index.cjs

@@ -1,18 +1,18 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/index.ts
-function ok(...args) {
+function Ok(...args) {
 	return args.length === 0 ? { tag: "Ok" } : {
 		tag: "Ok",
 		value: args[0]
 	};
 }
-function err(...args) {
+function Err(...args) {
 	return args.length === 0 ? { tag: "Err" } : {
 		tag: "Err",
 		error: args[0]
 	};
 }
-function defect(...args) {
+function Defect(...args) {
 	return args.length === 0 ? { tag: "Defect" } : {
 		tag: "Defect",
 		cause: args[0]
@@ -21,7 +21,7 @@ function defect(...args) {
 /**
 * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a
 * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads
-* better nested inside an {@link err} pattern and narrows to the matching
+* better nested inside an {@link Err} pattern and narrows to the matching
 * variant — including its payload.
 *
 * @typeParam Tag - the string literal tag to match.
@@ -29,14 +29,14 @@ function defect(...args) {
 *
 * @example
 * ```ts
-* .with(P.err(P.tag("Forbidden")), ({ error }) => error.user)
+* .with(P.Err(P.tag("Forbidden")), ({ error }) => error.user)
 * ```
 */
 function tag(value) {
 	return { _tag: value };
 }
 //#endregion
-exports.defect = defect;
-exports.err = err;
-exports.ok = ok;
+exports.Defect = Defect;
+exports.Err = Err;
+exports.Ok = Ok;
 exports.tag = tag;

package/dist/index.d.cts

@@ -7,10 +7,10 @@
  *
  * @typeParam V - the sub-pattern matched against the `Ok` value.
  */
-declare function ok(): {
+declare function Ok(): {
   tag: "Ok";
 };
-declare function ok<const V>(value: V): {
+declare function Ok<const V>(value: V): {
   tag: "Ok";
   value: V;
 };
@@ -21,10 +21,10 @@ declare function ok<const V>(value: V): {
  *
  * @typeParam V - the sub-pattern matched against the `Err` error.
  */
-declare function err(): {
+declare function Err(): {
   tag: "Err";
 };
-declare function err<const V>(error: V): {
+declare function Err<const V>(error: V): {
   tag: "Err";
   error: V;
 };
@@ -35,17 +35,17 @@ declare function err<const V>(error: V): {
  *
  * @typeParam V - the sub-pattern matched against the `Defect` cause.
  */
-declare function defect(): {
+declare function Defect(): {
   tag: "Defect";
 };
-declare function defect<const V>(cause: V): {
+declare function Defect<const V>(cause: V): {
   tag: "Defect";
   cause: V;
 };
 /**
  * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a
  * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads
- * better nested inside an {@link err} pattern and narrows to the matching
+ * better nested inside an {@link Err} pattern and narrows to the matching
  * variant — including its payload.
  *
  * @typeParam Tag - the string literal tag to match.
@@ -53,12 +53,12 @@ declare function defect<const V>(cause: V): {
  *
  * @example
  * ```ts
- * .with(P.err(P.tag("Forbidden")), ({ error }) => error.user)
+ * .with(P.Err(P.tag("Forbidden")), ({ error }) => error.user)
  * ```
  */
 declare function tag<const Tag extends string>(value: Tag): {
   _tag: Tag;
 };
 //#endregion
-export { defect, err, ok, tag };
+export { Defect, Err, Ok, tag };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -7,10 +7,10 @@
  *
  * @typeParam V - the sub-pattern matched against the `Ok` value.
  */
-declare function ok(): {
+declare function Ok(): {
   tag: "Ok";
 };
-declare function ok<const V>(value: V): {
+declare function Ok<const V>(value: V): {
   tag: "Ok";
   value: V;
 };
@@ -21,10 +21,10 @@ declare function ok<const V>(value: V): {
  *
  * @typeParam V - the sub-pattern matched against the `Err` error.
  */
-declare function err(): {
+declare function Err(): {
   tag: "Err";
 };
-declare function err<const V>(error: V): {
+declare function Err<const V>(error: V): {
   tag: "Err";
   error: V;
 };
@@ -35,17 +35,17 @@ declare function err<const V>(error: V): {
  *
  * @typeParam V - the sub-pattern matched against the `Defect` cause.
  */
-declare function defect(): {
+declare function Defect(): {
   tag: "Defect";
 };
-declare function defect<const V>(cause: V): {
+declare function Defect<const V>(cause: V): {
   tag: "Defect";
   cause: V;
 };
 /**
  * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a
  * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads
- * better nested inside an {@link err} pattern and narrows to the matching
+ * better nested inside an {@link Err} pattern and narrows to the matching
  * variant — including its payload.
  *
  * @typeParam Tag - the string literal tag to match.
@@ -53,12 +53,12 @@ declare function defect<const V>(cause: V): {
  *
  * @example
  * ```ts
- * .with(P.err(P.tag("Forbidden")), ({ error }) => error.user)
+ * .with(P.Err(P.tag("Forbidden")), ({ error }) => error.user)
  * ```
  */
 declare function tag<const Tag extends string>(value: Tag): {
   _tag: Tag;
 };
 //#endregion
-export { defect, err, ok, tag };
+export { Defect, Err, Ok, tag };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,17 +1,17 @@
 //#region src/index.ts
-function ok(...args) {
+function Ok(...args) {
 	return args.length === 0 ? { tag: "Ok" } : {
 		tag: "Ok",
 		value: args[0]
 	};
 }
-function err(...args) {
+function Err(...args) {
 	return args.length === 0 ? { tag: "Err" } : {
 		tag: "Err",
 		error: args[0]
 	};
 }
-function defect(...args) {
+function Defect(...args) {
 	return args.length === 0 ? { tag: "Defect" } : {
 		tag: "Defect",
 		cause: args[0]
@@ -20,7 +20,7 @@ function defect(...args) {
 /**
 * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a
 * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads
-* better nested inside an {@link err} pattern and narrows to the matching
+* better nested inside an {@link Err} pattern and narrows to the matching
 * variant — including its payload.
 *
 * @typeParam Tag - the string literal tag to match.
@@ -28,13 +28,13 @@ function defect(...args) {
 *
 * @example
 * ```ts
-* .with(P.err(P.tag("Forbidden")), ({ error }) => error.user)
+* .with(P.Err(P.tag("Forbidden")), ({ error }) => error.user)
 * ```
 */
 function tag(value) {
 	return { _tag: value };
 }
 //#endregion
-export { defect, err, ok, tag };
+export { Defect, Err, Ok, tag };
 
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["// @unthrown/pattern — native `ts-pattern` interop for `Result`.\n//\n// A `Result` is a discriminated union (`{ tag: \"Ok\" | \"Err\" | \"Defect\" }`), so\n// `ts-pattern` matches it directly — narrowing, selection, and `.exhaustive()`\n// all work out of the box. This package is just sugar: pattern constructors so\n// you can write `P.ok(...)` instead of the raw `{ tag: \"Ok\", value: ... }`\n// object pattern, plus `tag` for matching a `TaggedError` by its `_tag`.\n//\n//   import { match } from \"ts-pattern\";\n//   import * as P from \"@unthrown/pattern\";\n//\n//   match(result)\n//     .with(P.ok(), ({ value }) => `ok: ${value}`)\n//     .with(P.err(P.tag(\"NotFound\")), () => \"404\")\n//     .with(P.err(), ({ error }) => `error: ${error}`)\n//     .with(P.defect(), ({ cause }) => `bug: ${String(cause)}`)\n//     .exhaustive();\n//\n// Here `P` is THIS package. To also use ts-pattern's own patterns (wildcards,\n// `P.select()`, `P.string`, …), import ts-pattern's `P` under another name:\n//\n//   import { match, P as t } from \"ts-pattern\";\n//   import * as P from \"@unthrown/pattern\";\n//   match(result).with(P.ok(t.select()), (value) => value).otherwise(() => …);\n\n/**\n * A `ts-pattern` pattern matching the `Ok` variant of a `Result`. With no\n * argument it matches any `Ok`; pass a sub-pattern to constrain or select the\n * `value` — a literal, or any `ts-pattern` pattern (e.g. `ts-pattern`'s own\n * `P.string` / `P.select()`, imported from `ts-pattern`, not this package).\n *\n * @typeParam V - the sub-pattern matched against the `Ok` value.\n */\nexport function ok(): { tag: \"Ok\" };\nexport function ok<const V>(value: V): { tag: \"Ok\"; value: V };\nexport function ok(...args: [] | [unknown]): { tag: \"Ok\"; value?: unknown } {\n  return args.length === 0 ? { tag: \"Ok\" } : { tag: \"Ok\", value: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching the `Err` variant of a `Result`. With no\n * argument it matches any `Err`; pass a sub-pattern (e.g. {@link tag}) to\n * constrain or select the `error`.\n *\n * @typeParam V - the sub-pattern matched against the `Err` error.\n */\nexport function err(): { tag: \"Err\" };\nexport function err<const V>(error: V): { tag: \"Err\"; error: V };\nexport function err(...args: [] | [unknown]): { tag: \"Err\"; error?: unknown } {\n  return args.length === 0 ? { tag: \"Err\" } : { tag: \"Err\", error: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching the `Defect` variant of a `Result`. With no\n * argument it matches any `Defect`; pass a sub-pattern to constrain or select\n * the unknown `cause`.\n *\n * @typeParam V - the sub-pattern matched against the `Defect` cause.\n */\nexport function defect(): { tag: \"Defect\" };\nexport function defect<const V>(cause: V): { tag: \"Defect\"; cause: V };\nexport function defect(...args: [] | [unknown]): { tag: \"Defect\"; cause?: unknown } {\n  return args.length === 0 ? { tag: \"Defect\" } : { tag: \"Defect\", cause: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a\n * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads\n * better nested inside an {@link err} pattern and narrows to the matching\n * variant — including its payload.\n *\n * @typeParam Tag - the string literal tag to match.\n * @param value - the `_tag` to match.\n *\n * @example\n * ```ts\n * .with(P.err(P.tag(\"Forbidden\")), ({ error }) => error.user)\n * ```\n */\nexport function tag<const Tag extends string>(value: Tag): { _tag: Tag } {\n  return { _tag: value };\n}\n"],"mappings":";AAmCA,SAAgB,GAAG,GAAG,MAAsD;CAC1E,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,KAAK,IAAI;EAAE,KAAK;EAAM,OAAO,KAAK;CAAG;AACzE;AAWA,SAAgB,IAAI,GAAG,MAAuD;CAC5E,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,MAAM,IAAI;EAAE,KAAK;EAAO,OAAO,KAAK;CAAG;AAC3E;AAWA,SAAgB,OAAO,GAAG,MAA0D;CAClF,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,SAAS,IAAI;EAAE,KAAK;EAAU,OAAO,KAAK;CAAG;AACjF;;;;;;;;;;;;;;;AAgBA,SAAgB,IAA8B,OAA2B;CACvE,OAAO,EAAE,MAAM,MAAM;AACvB"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["// @unthrown/pattern — native `ts-pattern` interop for `Result`.\n//\n// A `Result` is a discriminated union (`{ tag: \"Ok\" | \"Err\" | \"Defect\" }`), so\n// `ts-pattern` matches it directly — narrowing, selection, and `.exhaustive()`\n// all work out of the box. This package is just sugar: pattern constructors so\n// you can write `P.Ok(...)` instead of the raw `{ tag: \"Ok\", value: ... }`\n// object pattern, plus `tag` for matching a `TaggedError` by its `_tag`.\n//\n//   import { match } from \"ts-pattern\";\n//   import * as P from \"@unthrown/pattern\";\n//\n//   match(result)\n//     .with(P.Ok(), ({ value }) => `ok: ${value}`)\n//     .with(P.Err(P.tag(\"NotFound\")), () => \"404\")\n//     .with(P.Err(), ({ error }) => `error: ${error}`)\n//     .with(P.Defect(), ({ cause }) => `bug: ${String(cause)}`)\n//     .exhaustive();\n//\n// Here `P` is THIS package. To also use ts-pattern's own patterns (wildcards,\n// `P.select()`, `P.string`, …), import ts-pattern's `P` under another name:\n//\n//   import { match, P as t } from \"ts-pattern\";\n//   import * as P from \"@unthrown/pattern\";\n//   match(result).with(P.Ok(t.select()), (value) => value).otherwise(() => …);\n\n/**\n * A `ts-pattern` pattern matching the `Ok` variant of a `Result`. With no\n * argument it matches any `Ok`; pass a sub-pattern to constrain or select the\n * `value` — a literal, or any `ts-pattern` pattern (e.g. `ts-pattern`'s own\n * `P.string` / `P.select()`, imported from `ts-pattern`, not this package).\n *\n * @typeParam V - the sub-pattern matched against the `Ok` value.\n */\nexport function Ok(): { tag: \"Ok\" };\nexport function Ok<const V>(value: V): { tag: \"Ok\"; value: V };\nexport function Ok(...args: [] | [unknown]): { tag: \"Ok\"; value?: unknown } {\n  return args.length === 0 ? { tag: \"Ok\" } : { tag: \"Ok\", value: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching the `Err` variant of a `Result`. With no\n * argument it matches any `Err`; pass a sub-pattern (e.g. {@link tag}) to\n * constrain or select the `error`.\n *\n * @typeParam V - the sub-pattern matched against the `Err` error.\n */\nexport function Err(): { tag: \"Err\" };\nexport function Err<const V>(error: V): { tag: \"Err\"; error: V };\nexport function Err(...args: [] | [unknown]): { tag: \"Err\"; error?: unknown } {\n  return args.length === 0 ? { tag: \"Err\" } : { tag: \"Err\", error: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching the `Defect` variant of a `Result`. With no\n * argument it matches any `Defect`; pass a sub-pattern to constrain or select\n * the unknown `cause`.\n *\n * @typeParam V - the sub-pattern matched against the `Defect` cause.\n */\nexport function Defect(): { tag: \"Defect\" };\nexport function Defect<const V>(cause: V): { tag: \"Defect\"; cause: V };\nexport function Defect(...args: [] | [unknown]): { tag: \"Defect\"; cause?: unknown } {\n  return args.length === 0 ? { tag: \"Defect\" } : { tag: \"Defect\", cause: args[0] };\n}\n\n/**\n * A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a\n * `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads\n * better nested inside an {@link Err} pattern and narrows to the matching\n * variant — including its payload.\n *\n * @typeParam Tag - the string literal tag to match.\n * @param value - the `_tag` to match.\n *\n * @example\n * ```ts\n * .with(P.Err(P.tag(\"Forbidden\")), ({ error }) => error.user)\n * ```\n */\nexport function tag<const Tag extends string>(value: Tag): { _tag: Tag } {\n  return { _tag: value };\n}\n"],"mappings":";AAmCA,SAAgB,GAAG,GAAG,MAAsD;CAC1E,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,KAAK,IAAI;EAAE,KAAK;EAAM,OAAO,KAAK;CAAG;AACzE;AAWA,SAAgB,IAAI,GAAG,MAAuD;CAC5E,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,MAAM,IAAI;EAAE,KAAK;EAAO,OAAO,KAAK;CAAG;AAC3E;AAWA,SAAgB,OAAO,GAAG,MAA0D;CAClF,OAAO,KAAK,WAAW,IAAI,EAAE,KAAK,SAAS,IAAI;EAAE,KAAK;EAAU,OAAO,KAAK;CAAG;AACjF;;;;;;;;;;;;;;;AAgBA,SAAgB,IAA8B,OAA2B;CACvE,OAAO,EAAE,MAAM,MAAM;AACvB"}

package/docs/index.md

@@ -6,15 +6,15 @@
 
 ## Functions
 
-### defect()
+### Defect()
 
 #### Call Signature
 
 ```ts
-function defect(): object;
+function Defect(): object;
 ```
 
-Defined in: [index.ts:60](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L60)
+Defined in: [index.ts:60](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L60)
 
 A `ts-pattern` pattern matching the `Defect` variant of a `Result`. With no
 argument it matches any `Defect`; pass a sub-pattern to constrain or select
@@ -26,15 +26,15 @@ the unknown `cause`.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `tag` | `"Defect"` | [index.ts:60](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L60) |
+| `tag` | `"Defect"` | [index.ts:60](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L60) |
 
 #### Call Signature
 
 ```ts
-function defect<V>(cause): object;
+function Defect<V>(cause): object;
 ```
 
-Defined in: [index.ts:61](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L61)
+Defined in: [index.ts:61](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L61)
 
 A `ts-pattern` pattern matching the `Defect` variant of a `Result`. With no
 argument it matches any `Defect`; pass a sub-pattern to constrain or select
@@ -58,20 +58,20 @@ the unknown `cause`.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `cause` | `V` | [index.ts:61](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L61) |
-| `tag` | `"Defect"` | [index.ts:61](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L61) |
+| `cause` | `V` | [index.ts:61](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L61) |
+| `tag` | `"Defect"` | [index.ts:61](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L61) |
 
 ***
 
-### err()
+### Err()
 
 #### Call Signature
 
 ```ts
-function err(): object;
+function Err(): object;
 ```
 
-Defined in: [index.ts:47](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L47)
+Defined in: [index.ts:47](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L47)
 
 A `ts-pattern` pattern matching the `Err` variant of a `Result`. With no
 argument it matches any `Err`; pass a sub-pattern (e.g. [tag](#tag)) to
@@ -83,15 +83,15 @@ constrain or select the `error`.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `tag` | `"Err"` | [index.ts:47](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L47) |
+| `tag` | `"Err"` | [index.ts:47](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L47) |
 
 #### Call Signature
 
 ```ts
-function err<V>(error): object;
+function Err<V>(error): object;
 ```
 
-Defined in: [index.ts:48](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L48)
+Defined in: [index.ts:48](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L48)
 
 A `ts-pattern` pattern matching the `Err` variant of a `Result`. With no
 argument it matches any `Err`; pass a sub-pattern (e.g. [tag](#tag)) to
@@ -115,20 +115,20 @@ constrain or select the `error`.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `error` | `V` | [index.ts:48](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L48) |
-| `tag` | `"Err"` | [index.ts:48](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L48) |
+| `error` | `V` | [index.ts:48](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L48) |
+| `tag` | `"Err"` | [index.ts:48](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L48) |
 
 ***
 
-### ok()
+### Ok()
 
 #### Call Signature
 
 ```ts
-function ok(): object;
+function Ok(): object;
 ```
 
-Defined in: [index.ts:34](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L34)
+Defined in: [index.ts:34](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L34)
 
 A `ts-pattern` pattern matching the `Ok` variant of a `Result`. With no
 argument it matches any `Ok`; pass a sub-pattern to constrain or select the
@@ -141,15 +141,15 @@ argument it matches any `Ok`; pass a sub-pattern to constrain or select the
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `tag` | `"Ok"` | [index.ts:34](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L34) |
+| `tag` | `"Ok"` | [index.ts:34](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L34) |
 
 #### Call Signature
 
 ```ts
-function ok<V>(value): object;
+function Ok<V>(value): object;
 ```
 
-Defined in: [index.ts:35](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L35)
+Defined in: [index.ts:35](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L35)
 
 A `ts-pattern` pattern matching the `Ok` variant of a `Result`. With no
 argument it matches any `Ok`; pass a sub-pattern to constrain or select the
@@ -174,8 +174,8 @@ argument it matches any `Ok`; pass a sub-pattern to constrain or select the
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `tag` | `"Ok"` | [index.ts:35](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L35) |
-| `value` | `V` | [index.ts:35](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L35) |
+| `tag` | `"Ok"` | [index.ts:35](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L35) |
+| `value` | `V` | [index.ts:35](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L35) |
 
 ***
 
@@ -185,11 +185,11 @@ argument it matches any `Ok`; pass a sub-pattern to constrain or select the
 function tag<Tag>(value): object;
 ```
 
-Defined in: [index.ts:80](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L80)
+Defined in: [index.ts:80](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L80)
 
 A `ts-pattern` pattern matching any value whose `_tag` equals `value` (e.g. a
 `TaggedError`). Equivalent to the object pattern `{ _tag: value }`, but reads
-better nested inside an [err](#err) pattern and narrows to the matching
+better nested inside an [Err](#err) pattern and narrows to the matching
 variant — including its payload.
 
 #### Type Parameters
@@ -210,10 +210,10 @@ variant — including its payload.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `_tag` | `Tag` | [index.ts:80](https://github.com/btravstack/unthrown/blob/1e34025e0177665dde9c50faca313fd1b95e5545/packages/pattern/src/index.ts#L80) |
+| `_tag` | `Tag` | [index.ts:80](https://github.com/btravstack/unthrown/blob/fa4c17ddc81bb2075e8f48dfcc49e5e04d951dd1/packages/pattern/src/index.ts#L80) |
 
 #### Example
 
 ```ts
-.with(P.err(P.tag("Forbidden")), ({ error }) => error.user)
+.with(P.Err(P.tag("Forbidden")), ({ error }) => error.user)
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unthrown/pattern",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "ts-pattern integration for unthrown",
   "keywords": [
     "errors-as-values",
@@ -43,7 +43,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "unthrown": "0.3.0"
+    "unthrown": "1.0.0"
   },
   "devDependencies": {
     "@types/node": "24.13.2",