@rimbu/deep 0.8.2 → 0.9.2

package/dist/module/path.js

@@ -8,10 +8,12 @@ export var Path;
      * @param source - the object to select in
      * @param path - the path into the object
      * @example
+     * ```ts
      * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b')
      * // => { c: 5 }
      * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b.c')
      * // => 5
+     * ```
      */
     function getValue(source, path) {
         const items = path.split('.');
@@ -28,7 +30,9 @@ export var Path;
      * @param path - the path in the object to update
      * @param value - the new value to set at the given position
      * @example
+     * ```ts
      * console.log(Path.setValue({ a: { b: { c: 5  } } }))
+     * ```
      */
     function setValue(source, path, value) {
         const items = path.split('.');
@@ -53,8 +57,10 @@ export var Path;
      * @param path - the path in the object to update
      * @param patches - one or more patches to update the value at the given path
      * @example
+     * ```ts
      * console.log(Path.setValue({ a: { b: { c: 5 } } }, 'a.b.c', 8)
      * // => { a: { b: { c: 8 } } }
+     * ```
      */
     function patchValue(source, path, ...patches) {
         const value = Path.getValue(source, path);

package/dist/module/path.js.map

@@ -1 +1 @@
-{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,EAAS,MAAM,YAAY,CAAC;AAYnD,MAAM,KAAW,IAAI,CAyGpB;AAzGD,WAAiB,IAAI;IAsBnB;;;;;;;;;;;OAWG;IACH,SAAgB,QAAQ,CACtB,MAAS,EACT,IAAO;QAEP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;QAEzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,aAAQ,WAavB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,QAAQ,CACtB,MAAS,EACT,IAAO,EACP,KAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,MAAM,MAAM,qBAAQ,MAAM,CAAE,CAAC;QAE7B,IAAI,OAAO,GAAQ,MAAM,CAAC;QAE1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,OAAO,CAAC,IAAI,CAAC,qBAAQ,OAAO,CAAC,IAAI,CAAC,CAAE,CAAC;YACrC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/B,IAAI,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAE9C,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAxBe,aAAQ,WAwBvB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,UAAU,CACxB,MAAS,EACT,IAAO,EACP,GAAG,OAAuC;QAE1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;QAE1C,IAAI,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;YAAE,OAAO,MAAM,CAAC;QAE9C,OAAO,IAAI,CAAC,QAAQ,CAAW,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAXe,eAAU,aAWzB,CAAA;AACH,CAAC,EAzGgB,IAAI,KAAJ,IAAI,QAyGpB"}
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,EAAS,MAAM,YAAY,CAAC;AAcnD,MAAM,KAAW,IAAI,CAiHpB;AAjHD,WAAiB,IAAI;IAwBnB;;;;;;;;;;;;;OAaG;IACH,SAAgB,QAAQ,CACtB,MAAS,EACT,IAAO;QAEP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;QAEzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,aAAQ,WAavB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,QAAQ,CACtB,MAAS,EACT,IAAO,EACP,KAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,MAAM,MAAM,qBAAQ,MAAM,CAAE,CAAC;QAE7B,IAAI,OAAO,GAAQ,MAAM,CAAC;QAE1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,OAAO,CAAC,IAAI,CAAC,qBAAQ,OAAO,CAAC,IAAI,CAAC,CAAE,CAAC;YACrC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/B,IAAI,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAE9C,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,MAAM,CAAC;IAChB,CAAC;IAxBe,aAAQ,WAwBvB,CAAA;IAED;;;;;;;;;;;OAWG;IACH,SAAgB,UAAU,CACxB,MAAS,EACT,IAAO,EACP,GAAG,OAAuC;QAE1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;QAE1C,IAAI,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;YAAE,OAAO,MAAM,CAAC;QAE9C,OAAO,IAAI,CAAC,QAAQ,CAAW,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAXe,eAAU,aAWzB,CAAA;AACH,CAAC,EAjHgB,IAAI,KAAJ,IAAI,QAiHpB"}

package/dist/module/tuple.js

@@ -5,8 +5,10 @@ export var Tuple;
      * Convenience method to type Tuple types
      * @param values - the values of the tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * // type of t => Tuple<[number, string, boolean]>
+     * ```
      */
     function of(...values) {
         return values;
@@ -17,9 +19,11 @@ export var Tuple;
      * @param tuple - the tuple to get the item from
      * @param index - the index in of the tuple element
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.getIndex(t, 1))
      * // => 'a'
+     * ```
      */
     function getIndex(tuple, index) {
         return tuple[index];
@@ -29,9 +33,11 @@ export var Tuple;
      * Returns the first element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.first(t))
      * // => 1
+     * ```
      */
     function first(tuple) {
         return tuple[0];
@@ -41,9 +47,11 @@ export var Tuple;
      * Returns the second element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.second(t))
      * // => 'a'
+     * ```
      */
     function second(tuple) {
         return tuple[1];
@@ -53,9 +61,11 @@ export var Tuple;
      * Returns the last element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.last(t))
      * // => true
+     * ```
      */
     function last(tuple) {
         return tuple[tuple.length - 1];
@@ -68,9 +78,11 @@ export var Tuple;
      * @param index - the index in the tuple
      * @param updater - the updater for the value
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.updateAt(t, 1, 'b'))
      * // => [1, 'b', true]
+     * ```
      */
     function updateAt(tuple, index, updater) {
         return Arr.update(tuple, index, updater);
@@ -81,9 +93,11 @@ export var Tuple;
      * @param tuple - the source tuple
      * @param values - the values to append
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a')
      * console.log(Tuple.append(t, true, 5))
      * // => [1, 'a', true, 5]
+     * ```
      */
     function append(tuple, ...values) {
         return [...tuple, ...values];
@@ -95,10 +109,12 @@ export var Tuple;
      * @param tuple1 - the first Tuple
      * @param tuple2 - the second Tuple
      * @example
+     * ```ts
      * const t1 = Tuple.of(1, 'a')
      * const t2 = Tuple.of(true, 5)
      * console.log(Tuple.concat(t1, t2))
      * // => [1, 'a', true, 5]
+     * ```
      */
     function concat(tuple1, tuple2) {
         return tuple1.concat(tuple2);
@@ -108,9 +124,11 @@ export var Tuple;
      * Returns a Tuple containing all but the last element of the given `tuple`.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.init(t))
      * // => [1, 'a']
+     * ```
      */
     function init(tuple) {
         return Arr.init(tuple);
@@ -120,9 +138,11 @@ export var Tuple;
      * Returns a Tuple containing all but the first element of the given `tuple`.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.tail(t))
      * // => ['a', true]
+     * ```
      */
     function tail(tuple) {
         return Arr.tail(tuple);

package/dist/module/tuple.js.map

@@ -1 +1 @@
-{"version":3,"file":"tuple.js","sourceRoot":"","sources":["../../src/tuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAQlC,MAAM,KAAW,KAAK,CA4JrB;AA5JD,WAAiB,KAAK;IAWpB;;;;;;OAMG;IACH,SAAgB,EAAE,CAAiC,GAAG,MAAS;QAC7D,OAAO,MAAa,CAAC;IACvB,CAAC;IAFe,QAAE,KAEjB,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,QAAQ,CACtB,KAAQ,EACR,KAAQ;QAER,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IALe,cAAQ,WAKvB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,KAAK,CAAyB,KAAQ;QACpD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAFe,WAAK,QAEpB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,MAAM,CAAyB,KAAQ;QACrD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAFe,YAAM,SAErB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,IAAI,CAClB,KAAyB;QAEzB,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAQ,CAAC;IACxC,CAAC;IAJe,UAAI,OAInB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,QAAQ,CACtB,KAAQ,EACR,KAAQ,EACR,OAAqB;QAErB,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,KAAe,EAAE,OAAO,CAAM,CAAC;IAC1D,CAAC;IANe,cAAQ,WAMvB,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAGpB,KAAQ,EAAE,GAAG,MAAS;QACtB,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC/B,CAAC;IALe,YAAM,SAKrB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CACpB,MAAU,EACV,MAAU;QAEV,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAQ,CAAC;IACtC,CAAC;IALe,YAAM,SAKrB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,IAAI,CAClB,KAA+B;QAE/B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAQ,CAAC;IAChC,CAAC;IAJe,UAAI,OAInB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,IAAI,CAClB,KAA+B;QAE/B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAQ,CAAC;IAChC,CAAC;IAJe,UAAI,OAInB,CAAA;AACH,CAAC,EA5JgB,KAAK,KAAL,KAAK,QA4JrB"}
+{"version":3,"file":"tuple.js","sourceRoot":"","sources":["../../src/tuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAQlC,MAAM,KAAW,KAAK,CAgLrB;AAhLD,WAAiB,KAAK;IAWpB;;;;;;;;OAQG;IACH,SAAgB,EAAE,CAAiC,GAAG,MAAS;QAC7D,OAAO,MAAa,CAAC;IACvB,CAAC;IAFe,QAAE,KAEjB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,QAAQ,CACtB,KAAQ,EACR,KAAQ;QAER,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IALe,cAAQ,WAKvB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,KAAK,CAAyB,KAAQ;QACpD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAFe,WAAK,QAEpB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,MAAM,CAAyB,KAAQ;QACrD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAFe,YAAM,SAErB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,IAAI,CAClB,KAAyB;QAEzB,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAQ,CAAC;IACxC,CAAC;IAJe,UAAI,OAInB,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,QAAQ,CACtB,KAAQ,EACR,KAAQ,EACR,OAAqB;QAErB,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,KAAe,EAAE,OAAO,CAAM,CAAC;IAC1D,CAAC;IANe,cAAQ,WAMvB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CAGpB,KAAQ,EAAE,GAAG,MAAS;QACtB,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC/B,CAAC;IALe,YAAM,SAKrB,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,MAAM,CACpB,MAAU,EACV,MAAU;QAEV,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAQ,CAAC;IACtC,CAAC;IALe,YAAM,SAKrB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,IAAI,CAClB,KAA+B;QAE/B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAQ,CAAC;IAChC,CAAC;IAJe,UAAI,OAInB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,IAAI,CAClB,KAA+B;QAE/B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAQ,CAAC;IAChC,CAAC;IAJe,UAAI,OAInB,CAAA;AACH,CAAC,EAhLgB,KAAK,KAAL,KAAK,QAgLrB"}

package/dist/types/index.d.ts

@@ -1 +1,8 @@
+/**
+ * @packageDocumentation
+ *
+ * The `@rimbu/deep` package provides utilities to patch and match plain JavaScript objects..<br/>
+ * <br/>
+ * See the [Rimbu docs Deep overview page](/docs/deep/overview) for more information.
+ */
 export * from './internal';

package/dist/types/match.d.ts

@@ -47,8 +47,10 @@ export declare namespace Match {
      * @param value - the value to match
      * @param matchers - one or more `Match` objects
      * @example
+     * ```ts
      * matchAll({ g: { h: 'abc' }})({ g: { h: 'a' }}) => false
      * matchAll({ g: { h: 'abc' }})({ g: { h: v => v.length > 1 }}) => true
+     * ```
      */
     function all<T>(value: T): (...matchers: Match.Multi<T>) => boolean;
     /**
@@ -57,8 +59,10 @@ export declare namespace Match {
      * @param value - the value to match
      * @param matchers - one or more `Match` objects
      * @example
+     * ```ts
      * matchAny({ g: { h: 'abc' }})({ g: { h: 'a' }}, { g: { h: v => v.length < 2 }}) => false
      * matchAny({ g: { h: 'abc' }})({ g: { h: 'a' }}, { g: { h: v => v.length > 1 }}) => true
+     * ```
      */
     function any<T>(value: T): (...matchers: Match.Multi<T>) => boolean;
     /**
@@ -68,6 +72,7 @@ export declare namespace Match {
      * @typeparam T2 - the type to use for the Match, should be equal to T
      * @param matches - at least one Match instance to perform on a given `value`
      * @example
+     * ```ts
      * type Person = { name: string, age: number }
      * const m = Match.createAll<Person>({ age: v => v > 20 }, { name: v => v.length > 2 })
      *
@@ -77,6 +82,7 @@ export declare namespace Match {
      * // => true
      * console.log(m({ name: 'a', age: 20 }))
      * // => false
+     * ```
      */
     function createAll<T, T2 extends T = T>(...matches: Match.Multi<T2>): (value: T) => boolean;
     /**
@@ -86,6 +92,7 @@ export declare namespace Match {
      * @typeparam T2 - the type to use for the Match, should be equal to T
      * @param matches - at least one Match instance to perform on a given `value`
      * @example
+     * ```ts
      * type Person = { name: string, age: number }
      * const m = Match.createAny<Person>({ age: v => v > 20 }, { name: v => v.length > 2 })
      *
@@ -97,6 +104,7 @@ export declare namespace Match {
      * // => true
      * console.log(m({ name: 'a', age: 10 }))
      * // => false
+     * ```
      */
     function createAny<T, T2 extends T = T>(...matches: Match.Multi<T2>): (value: T) => boolean;
 }

package/dist/types/patch.d.ts

@@ -15,12 +15,14 @@ declare type PatchHelper<T, P, R> = T extends Literal.Obj ? Patch.PatchObj<T, P,
  * @param value - the value to update
  * @param patches - one or more `Patch` objects indicating modifications to the value
  * @example
+ * ```ts
  * patch({ g: { h: 5 }})({ g: { h: 6 }})          // => { g: { h: 6 }}
  * patch({ g: { h: 5 }})({ g: { h: v => v + 1 }}) // => { g: { h: 6 }}
  * patch({ g: { h: 5 }})({ g: { h: 1 }}, { g: { h: v => v + 1 }})
  * // => { g: { h: 2 }}
  * patch({ a: 1, b: 3 })({ a: (v, p) => v * p.b, (v, p) => v + p.a })
  * // => { a: 3, b: 4 }
+ * ```
  */
 export declare function patch<T>(value: T): (...patches: Patch.Multi<T>) => T;
 export declare namespace Patch {
@@ -66,9 +68,11 @@ export declare namespace Patch {
      * @typeparam T2 - the type the Patch is done for, should be equal to T
      * @param patches - the patches to apply to a given object
      * @example
+     * ```ts
      * const r = Patch.create<{ a: number, b: number }>({ b: v => v + 1 })({ a: 1, b: 2})
      * console.log(r)
      * // => { a: 1, b: 3 }
+     * ```
      */
     function create<T, T2 extends T = T>(...patches: Patch.Multi<T2>): (value: T) => T;
 }

package/dist/types/path.d.ts

@@ -3,7 +3,9 @@ import { Literal, Patch } from './internal';
  * A string representing a path into an (nested) object of type T.
  * @typeparam T - the object type to select in
  * @example
+ * ```ts
  * const p: Path<{ a: { b: { c : 5 }}}> = 'a.b'
+ * ```
  */
 export declare type Path<T> = T extends Literal.Obj ? {
     [K in string & keyof T]: `${K}` | `${K}.${Path<T[K]>}`;
@@ -14,8 +16,10 @@ export declare namespace Path {
      * @typeparam T - the object type to select in
      * @typeparam P - a Path in object type T
      * @example
+     * ```ts
      * let r!: Path.Result<{ a: { b: { c: number } } }, 'a.b'>;
      * // => type of r: { c: number }
+     * ```
      */
     type Result<T, P extends Path<T> = Path<T>> = T extends Record<string, unknown> ? P extends `${infer Head}.${infer Rest}` ? Head extends keyof T ? Path.Result<T[Head], Rest & Path<T[Head]>> : never : P extends `${infer K}` ? T[K] : never : never;
     /**
@@ -25,10 +29,12 @@ export declare namespace Path {
      * @param source - the object to select in
      * @param path - the path into the object
      * @example
+     * ```ts
      * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b')
      * // => { c: 5 }
      * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b.c')
      * // => 5
+     * ```
      */
     function getValue<T, P extends Path<T> = Path<T>>(source: T, path: P): Path.Result<T, P>;
     /**
@@ -37,7 +43,9 @@ export declare namespace Path {
      * @param path - the path in the object to update
      * @param value - the new value to set at the given position
      * @example
+     * ```ts
      * console.log(Path.setValue({ a: { b: { c: 5  } } }))
+     * ```
      */
     function setValue<T, P extends Path<T> = Path<T>>(source: T, path: P, value: Path.Result<T, P>): T;
     /**
@@ -47,8 +55,10 @@ export declare namespace Path {
      * @param path - the path in the object to update
      * @param patches - one or more patches to update the value at the given path
      * @example
+     * ```ts
      * console.log(Path.setValue({ a: { b: { c: 5 } } }, 'a.b.c', 8)
      * // => { a: { b: { c: 8 } } }
+     * ```
      */
     function patchValue<T, P extends Path<T> = Path<T>>(source: T, path: P, ...patches: Patch.Multi<Path.Result<T, P>>): T;
 }

package/dist/types/tuple.d.ts

@@ -16,8 +16,10 @@ export declare namespace Tuple {
      * Convenience method to type Tuple types
      * @param values - the values of the tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * // type of t => Tuple<[number, string, boolean]>
+     * ```
      */
     function of<T extends Tuple.NonEmptySource>(...values: T): Tuple<T>;
     /**
@@ -25,36 +27,44 @@ export declare namespace Tuple {
      * @param tuple - the tuple to get the item from
      * @param index - the index in of the tuple element
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.getIndex(t, 1))
      * // => 'a'
+     * ```
      */
     function getIndex<T extends Tuple.Source, K extends keyof T = keyof T>(tuple: T, index: K): T[K];
     /**
      * Returns the first element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.first(t))
      * // => 1
+     * ```
      */
     function first<T extends Tuple.Source>(tuple: T): T[0];
     /**
      * Returns the second element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.second(t))
      * // => 'a'
+     * ```
      */
     function second<T extends Tuple.Source>(tuple: T): T[1];
     /**
      * Returns the last element of a Tuple.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.last(t))
      * // => true
+     * ```
      */
     function last<T extends readonly unknown[], R>(tuple: readonly [...T, R]): R;
     /**
@@ -64,9 +74,11 @@ export declare namespace Tuple {
      * @param index - the index in the tuple
      * @param updater - the updater for the value
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.updateAt(t, 1, 'b'))
      * // => [1, 'b', true]
+     * ```
      */
     function updateAt<T extends Tuple.Source, K extends keyof T = keyof T>(tuple: T, index: K, updater: Update<T[K]>): T;
     /**
@@ -74,9 +86,11 @@ export declare namespace Tuple {
      * @param tuple - the source tuple
      * @param values - the values to append
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a')
      * console.log(Tuple.append(t, true, 5))
      * // => [1, 'a', true, 5]
+     * ```
      */
     function append<T extends Tuple.Source, V extends readonly [unknown, ...unknown[]]>(tuple: T, ...values: V): readonly [...T, ...V];
     /**
@@ -85,28 +99,34 @@ export declare namespace Tuple {
      * @param tuple1 - the first Tuple
      * @param tuple2 - the second Tuple
      * @example
+     * ```ts
      * const t1 = Tuple.of(1, 'a')
      * const t2 = Tuple.of(true, 5)
      * console.log(Tuple.concat(t1, t2))
      * // => [1, 'a', true, 5]
+     * ```
      */
     function concat<T1 extends Tuple.Source, T2 extends Tuple.Source>(tuple1: T1, tuple2: T2): readonly [...T1, ...T2];
     /**
      * Returns a Tuple containing all but the last element of the given `tuple`.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.init(t))
      * // => [1, 'a']
+     * ```
      */
     function init<T extends readonly unknown[]>(tuple: readonly [...T, unknown]): Readonly<T>;
     /**
      * Returns a Tuple containing all but the first element of the given `tuple`.
      * @param tuple - the source tuple
      * @example
+     * ```ts
      * const t = Tuple.of(1, 'a', true)
      * console.log(Tuple.tail(t))
      * // => ['a', true]
+     * ```
      */
     function tail<T extends readonly [...unknown[]]>(tuple: readonly [unknown, ...T]): Readonly<T>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/deep",
-  "version": "0.8.2",
+  "version": "0.9.2",
   "description": "Tools to use handle plain JS objects as immutable objects",
   "keywords": [
     "immutable",
@@ -40,12 +40,13 @@
   ],
   "scripts": {
     "build": "yarn clean && yarn bundle",
-    "build:deno": "rimraf deno_dist ../../deno_dist/deep && denoify && cp ../../config/mod_ts_template deno_dist/mod.ts && mv deno_dist ../../deno_dist/deep",
+    "build:deno": "rimraf deno_dist ../../deno_dist/deep && denoify && mv deno_dist ../../deno_dist/deep",
     "bundle": "yarn bundle:main && yarn bundle:module && yarn bundle:types",
     "bundle:main": "tsc --p tsconfig.main.json",
     "bundle:module": "tsc --p tsconfig.module.json",
     "bundle:types": "tsc --p tsconfig.types.json",
     "clean": "rimraf dist",
+    "extract-api": "api-extractor run --local --verbose --config config/api-extractor.main.json",
     "format": "yarn format:base --write",
     "format:base": "prettier \"{!CHANGELOG.md}|**/**/*.{ts,tsx,js,json,md}\"",
     "format:check": "yarn format:base --check",
@@ -56,15 +57,16 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@rimbu/base": "^0.7.2",
-    "@rimbu/common": "^0.8.2",
-    "tslib": "^2.3.1"
+    "@rimbu/base": "^0.8.2",
+    "@rimbu/common": "^0.9.2",
+    "tslib": "^2.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "denoify": {
+    "index": "src/index.ts",
     "replacer": "../../config/denoify-rimbu-replacer.js"
   },
-  "gitHead": "1594b907f4dbbd994a52f0e2e94ffd9217420ff5"
+  "gitHead": "33dd7ca935f19f513586834a2ce1b1f886352ae7"
 }

package/src/index.ts

@@ -1 +1,9 @@
+/**
+ * @packageDocumentation
+ *
+ * The `@rimbu/deep` package provides utilities to patch and match plain JavaScript objects..<br/>
+ * <br/>
+ * See the [Rimbu docs Deep overview page](/docs/deep/overview) for more information.
+ */
+
 export * from './internal';

package/src/match.ts

@@ -69,8 +69,10 @@ export namespace Match {
    * @param value - the value to match
    * @param matchers - one or more `Match` objects
    * @example
+   * ```ts
    * matchAll({ g: { h: 'abc' }})({ g: { h: 'a' }}) => false
    * matchAll({ g: { h: 'abc' }})({ g: { h: v => v.length > 1 }}) => true
+   * ```
    */
   export function all<T>(value: T): (...matchers: Match.Multi<T>) => boolean {
     return (...matchers): boolean => {
@@ -90,8 +92,10 @@ export namespace Match {
    * @param value - the value to match
    * @param matchers - one or more `Match` objects
    * @example
+   * ```ts
    * matchAny({ g: { h: 'abc' }})({ g: { h: 'a' }}, { g: { h: v => v.length < 2 }}) => false
    * matchAny({ g: { h: 'abc' }})({ g: { h: 'a' }}, { g: { h: v => v.length > 1 }}) => true
+   * ```
    */
   export function any<T>(value: T): (...matchers: Match.Multi<T>) => boolean {
     return (...matchers): boolean => {
@@ -112,6 +116,7 @@ export namespace Match {
    * @typeparam T2 - the type to use for the Match, should be equal to T
    * @param matches - at least one Match instance to perform on a given `value`
    * @example
+   * ```ts
    * type Person = { name: string, age: number }
    * const m = Match.createAll<Person>({ age: v => v > 20 }, { name: v => v.length > 2 })
    *
@@ -121,6 +126,7 @@ export namespace Match {
    * // => true
    * console.log(m({ name: 'a', age: 20 }))
    * // => false
+   * ```
    */
   export function createAll<T, T2 extends T = T>(
     ...matches: Match.Multi<T2>
@@ -135,6 +141,7 @@ export namespace Match {
    * @typeparam T2 - the type to use for the Match, should be equal to T
    * @param matches - at least one Match instance to perform on a given `value`
    * @example
+   * ```ts
    * type Person = { name: string, age: number }
    * const m = Match.createAny<Person>({ age: v => v > 20 }, { name: v => v.length > 2 })
    *
@@ -146,6 +153,7 @@ export namespace Match {
    * // => true
    * console.log(m({ name: 'a', age: 10 }))
    * // => false
+   * ```
    */
   export function createAny<T, T2 extends T = T>(
     ...matches: Match.Multi<T2>

package/src/patch.ts

@@ -23,12 +23,14 @@ type PatchHelper<T, P, R> = T extends Literal.Obj
  * @param value - the value to update
  * @param patches - one or more `Patch` objects indicating modifications to the value
  * @example
+ * ```ts
  * patch({ g: { h: 5 }})({ g: { h: 6 }})          // => { g: { h: 6 }}
  * patch({ g: { h: 5 }})({ g: { h: v => v + 1 }}) // => { g: { h: 6 }}
  * patch({ g: { h: 5 }})({ g: { h: 1 }}, { g: { h: v => v + 1 }})
  * // => { g: { h: 2 }}
  * patch({ a: 1, b: 3 })({ a: (v, p) => v * p.b, (v, p) => v + p.a })
  * // => { a: 3, b: 4 }
+ * ```
  */
 export function patch<T>(value: T): (...patches: Patch.Multi<T>) => T {
   return function (...patches): T {
@@ -100,9 +102,11 @@ export namespace Patch {
    * @typeparam T2 - the type the Patch is done for, should be equal to T
    * @param patches - the patches to apply to a given object
    * @example
+   * ```ts
    * const r = Patch.create<{ a: number, b: number }>({ b: v => v + 1 })({ a: 1, b: 2})
    * console.log(r)
    * // => { a: 1, b: 3 }
+   * ```
    */
   export function create<T, T2 extends T = T>(
     ...patches: Patch.Multi<T2>

package/src/path.ts

@@ -4,7 +4,9 @@ import { Literal, patch, Patch } from './internal';
  * A string representing a path into an (nested) object of type T.
  * @typeparam T - the object type to select in
  * @example
+ * ```ts
  * const p: Path<{ a: { b: { c : 5 }}}> = 'a.b'
+ * ```
  */
 export type Path<T> = T extends Literal.Obj
   ? { [K in string & keyof T]: `${K}` | `${K}.${Path<T[K]>}` }[string & keyof T]
@@ -16,8 +18,10 @@ export namespace Path {
    * @typeparam T - the object type to select in
    * @typeparam P - a Path in object type T
    * @example
+   * ```ts
    * let r!: Path.Result<{ a: { b: { c: number } } }, 'a.b'>;
    * // => type of r: { c: number }
+   * ```
    */
   export type Result<T, P extends Path<T> = Path<T>> = T extends Record<
     string,
@@ -39,10 +43,12 @@ export namespace Path {
    * @param source - the object to select in
    * @param path - the path into the object
    * @example
+   * ```ts
    * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b')
    * // => { c: 5 }
    * console.log(Path.getValue({ a: { b: { c: 5 } } }), 'a.b.c')
    * // => 5
+   * ```
    */
   export function getValue<T, P extends Path<T> = Path<T>>(
     source: T,
@@ -65,7 +71,9 @@ export namespace Path {
    * @param path - the path in the object to update
    * @param value - the new value to set at the given position
    * @example
+   * ```ts
    * console.log(Path.setValue({ a: { b: { c: 5  } } }))
+   * ```
    */
   export function setValue<T, P extends Path<T> = Path<T>>(
     source: T,
@@ -100,8 +108,10 @@ export namespace Path {
    * @param path - the path in the object to update
    * @param patches - one or more patches to update the value at the given path
    * @example
+   * ```ts
    * console.log(Path.setValue({ a: { b: { c: 5 } } }, 'a.b.c', 8)
    * // => { a: { b: { c: 8 } } }
+   * ```
    */
   export function patchValue<T, P extends Path<T> = Path<T>>(
     source: T,