From 3b1967f1e71cd3bc5574530b1083591e55b952a2 Mon Sep 17 00:00:00 2001 From: morganbarrett Date: Mon, 17 Feb 2025 02:23:22 +0000 Subject: [PATCH] fix: wrong exports dir --- docs/functions/clone.html | 2 +- docs/functions/decode.html | 2 +- docs/functions/encode.html | 2 +- docs/functions/isComplexArray.html | 2 +- docs/functions/isComplexObject.html | 2 +- docs/functions/isComplexProperty.html | 2 +- docs/functions/isInfinity.html | 2 +- docs/functions/isInstanceOf.html | 2 +- docs/functions/isNegativeZero.html | 2 +- docs/functions/isNotANumber.html | 2 +- docs/functions/isPureArray.html | 2 +- docs/functions/isPureObject.html | 2 +- docs/functions/isRegistrySymbol.html | 2 +- docs/functions/isShape.html | 2 +- docs/functions/isShapeLike.html | 2 +- docs/functions/makeClassGroupTransform.html | 2 +- docs/functions/makeClassTransform.html | 2 +- docs/functions/makeScopedTransform.html | 2 +- docs/functions/makeTransform.html | 2 +- docs/functions/makeValueGroupTransform.html | 2 +- docs/functions/objectMap.html | 2 +- docs/functions/parse.html | 2 +- docs/functions/stringify.html | 2 +- docs/index.html | 1 + docs/types/BuiltTransform.html | 2 +- docs/types/InstanceOfClassInRecord.html | 2 +- docs/types/MakeClassGroupTransformOptions.html | 2 +- docs/types/MakeClassTransformOptions.html | 2 +- docs/types/MakeScopedTransformOptions.html | 2 +- docs/types/MakeTransformOptions.html | 2 +- docs/types/MakeValueGroupTransformOptions.html | 2 +- docs/types/Primitive.html | 2 +- docs/types/SerializeOptions.html | 2 +- docs/types/Shape.html | 2 +- docs/types/ShapeLike.html | 2 +- docs/types/Transform.html | 2 +- docs/types/TransformedPrimitive.html | 2 +- docs/types/Validate.html | 2 +- docs/variables/arrayBufferTransform.html | 2 +- docs/variables/bigIntTransform.html | 2 +- docs/variables/complexArrayTransform.html | 2 +- docs/variables/complexObjectTransform.html | 2 +- docs/variables/dataViewTransform.html | 2 +- docs/variables/dateTransform.html | 2 +- docs/variables/errorClassTransform.html | 2 +- docs/variables/infinityTransform.html | 2 +- docs/variables/mapTransform.html | 2 +- docs/variables/nanTransform.html | 2 +- docs/variables/negativeZeroTransform.html | 2 +- docs/variables/primitiveClassTransform.html | 2 +- docs/variables/regExpTransform.html | 2 +- docs/variables/registrySymbolTransform.html | 2 +- docs/variables/setTransform.html | 2 +- docs/variables/transforms.html | 2 +- docs/variables/typedArrayTransform.html | 2 +- docs/variables/undefinedTransform.html | 2 +- docs/variables/wellKnownSymbolTransform.html | 2 +- package.json | 10 +++++----- 58 files changed, 62 insertions(+), 61 deletions(-) diff --git a/docs/functions/clone.html b/docs/functions/clone.html index 31074ef..b82cc0d 100644 --- a/docs/functions/clone.html +++ b/docs/functions/clone.html @@ -1 +1 @@ -clone | extended-serializer

Function clone

Settings

Member Visibility
+clone | extended-serializer

Function clone

Settings

Member Visibility
diff --git a/docs/functions/decode.html b/docs/functions/decode.html index 4861977..f2ff2e0 100644 --- a/docs/functions/decode.html +++ b/docs/functions/decode.html @@ -1 +1 @@ -decode | extended-serializer

Function decode

Settings

Member Visibility
+decode | extended-serializer

Function decode

Settings

Member Visibility
diff --git a/docs/functions/encode.html b/docs/functions/encode.html index c0a0ffc..15b05bf 100644 --- a/docs/functions/encode.html +++ b/docs/functions/encode.html @@ -1 +1 @@ -encode | extended-serializer

Function encode

Settings

Member Visibility
+encode | extended-serializer

Function encode

Settings

Member Visibility
diff --git a/docs/functions/isComplexArray.html b/docs/functions/isComplexArray.html index 890c742..1413767 100644 --- a/docs/functions/isComplexArray.html +++ b/docs/functions/isComplexArray.html @@ -1 +1 @@ -isComplexArray | extended-serializer

Function isComplexArray

Settings

Member Visibility
+isComplexArray | extended-serializer

Function isComplexArray

Settings

Member Visibility
diff --git a/docs/functions/isComplexObject.html b/docs/functions/isComplexObject.html index 27f268b..9d338af 100644 --- a/docs/functions/isComplexObject.html +++ b/docs/functions/isComplexObject.html @@ -1 +1 @@ -isComplexObject | extended-serializer

Function isComplexObject

  • isComplexObject(
        value: unknown,
    ): value is Record<string | number | symbol, unknown>

    Parameters

    • value: unknown

    Returns value is Record<string | number | symbol, unknown>

Settings

Member Visibility
+isComplexObject | extended-serializer

Function isComplexObject

  • isComplexObject(
        value: unknown,
    ): value is Record<string | number | symbol, unknown>

    Parameters

    • value: unknown

    Returns value is Record<string | number | symbol, unknown>

Settings

Member Visibility
diff --git a/docs/functions/isComplexProperty.html b/docs/functions/isComplexProperty.html index 26a304e..c5834ec 100644 --- a/docs/functions/isComplexProperty.html +++ b/docs/functions/isComplexProperty.html @@ -1 +1 @@ -isComplexProperty | extended-serializer

Function isComplexProperty

  • isComplexProperty(
        descriptor: PropertyDescriptor,
    ): undefined | true | (v: any) => void

    Parameters

    • descriptor: PropertyDescriptor

    Returns undefined | true | (v: any) => void

Settings

Member Visibility
+isComplexProperty | extended-serializer

Function isComplexProperty

  • isComplexProperty(descriptor: PropertyDescriptor): boolean

    Parameters

    • descriptor: PropertyDescriptor

    Returns boolean

Settings

Member Visibility
diff --git a/docs/functions/isInfinity.html b/docs/functions/isInfinity.html index d2bfbcc..b0666ec 100644 --- a/docs/functions/isInfinity.html +++ b/docs/functions/isInfinity.html @@ -1 +1 @@ -isInfinity | extended-serializer

Function isInfinity

  • isInfinity(value: unknown): value is number

    Parameters

    • value: unknown

    Returns value is number

Settings

Member Visibility
+isInfinity | extended-serializer

Function isInfinity

  • isInfinity(value: unknown): value is number

    Parameters

    • value: unknown

    Returns value is number

Settings

Member Visibility
diff --git a/docs/functions/isInstanceOf.html b/docs/functions/isInstanceOf.html index b3f59db..8d9a39e 100644 --- a/docs/functions/isInstanceOf.html +++ b/docs/functions/isInstanceOf.html @@ -1 +1 @@ -isInstanceOf | extended-serializer

Function isInstanceOf

  • isInstanceOf<T>(
        value: unknown,
        constructor: new (...args: any[]) => T,
    ): value is T

    Type Parameters

    • T

    Parameters

    • value: unknown
    • constructor: new (...args: any[]) => T

    Returns value is T

Settings

Member Visibility
+isInstanceOf | extended-serializer

Function isInstanceOf

  • isInstanceOf<T>(
        value: unknown,
        constructor: new (...args: any[]) => T,
    ): value is T

    Type Parameters

    • T

    Parameters

    • value: unknown
    • constructor: new (...args: any[]) => T

    Returns value is T

Settings

Member Visibility
diff --git a/docs/functions/isNegativeZero.html b/docs/functions/isNegativeZero.html index 28be71f..956d23b 100644 --- a/docs/functions/isNegativeZero.html +++ b/docs/functions/isNegativeZero.html @@ -1 +1 @@ -isNegativeZero | extended-serializer

Function isNegativeZero

Settings

Member Visibility
+isNegativeZero | extended-serializer

Function isNegativeZero

Settings

Member Visibility
diff --git a/docs/functions/isNotANumber.html b/docs/functions/isNotANumber.html index c80fbc2..656ba19 100644 --- a/docs/functions/isNotANumber.html +++ b/docs/functions/isNotANumber.html @@ -1 +1 @@ -isNotANumber | extended-serializer

Function isNotANumber

Settings

Member Visibility
+isNotANumber | extended-serializer

Function isNotANumber

Settings

Member Visibility
diff --git a/docs/functions/isPureArray.html b/docs/functions/isPureArray.html index 5096bc6..8f198f5 100644 --- a/docs/functions/isPureArray.html +++ b/docs/functions/isPureArray.html @@ -1,2 +1,2 @@ isPureArray | extended-serializer

Function isPureArray

  • isPureArray(value: unknown): value is unknown[]

    Parameters

    • value: unknown

    Returns value is unknown[]

    true when the value is a direct instance of Array

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/isPureObject.html b/docs/functions/isPureObject.html index 0be1080..8426b82 100644 --- a/docs/functions/isPureObject.html +++ b/docs/functions/isPureObject.html @@ -1,2 +1,2 @@ isPureObject | extended-serializer

Function isPureObject

  • isPureObject(value: unknown): value is Record<string | number | symbol, unknown>

    Parameters

    • value: unknown

    Returns value is Record<string | number | symbol, unknown>

    true when the value is a direct instance of Object

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/isRegistrySymbol.html b/docs/functions/isRegistrySymbol.html index 6784753..4c41947 100644 --- a/docs/functions/isRegistrySymbol.html +++ b/docs/functions/isRegistrySymbol.html @@ -1 +1 @@ -isRegistrySymbol | extended-serializer

Function isRegistrySymbol

Settings

Member Visibility
+isRegistrySymbol | extended-serializer

Function isRegistrySymbol

Settings

Member Visibility
diff --git a/docs/functions/isShape.html b/docs/functions/isShape.html index 2133b22..f38da26 100644 --- a/docs/functions/isShape.html +++ b/docs/functions/isShape.html @@ -1 +1 @@ -isShape | extended-serializer

Function isShape

Settings

Member Visibility
+isShape | extended-serializer

Function isShape

Settings

Member Visibility
diff --git a/docs/functions/isShapeLike.html b/docs/functions/isShapeLike.html index cb7cf88..555d4c3 100644 --- a/docs/functions/isShapeLike.html +++ b/docs/functions/isShapeLike.html @@ -1 +1 @@ -isShapeLike | extended-serializer

Function isShapeLike

Settings

Member Visibility
+isShapeLike | extended-serializer

Function isShapeLike

Settings

Member Visibility
diff --git a/docs/functions/makeClassGroupTransform.html b/docs/functions/makeClassGroupTransform.html index 938a7df..89165b3 100644 --- a/docs/functions/makeClassGroupTransform.html +++ b/docs/functions/makeClassGroupTransform.html @@ -1 +1 @@ -makeClassGroupTransform | extended-serializer

Function makeClassGroupTransform

  • makeClassGroupTransform<
        Keys extends string,
        Values extends new (...args: any[]) => any,
        Classes extends Record<Keys, Values>,
        Args extends any[],
    >(
        __namedParameters: MakeClassGroupTransformOptions<
            Keys,
            Values,
            Classes,
            Args,
        >,
    ): Transform<
        Simplify<
            {
                [K in string
                | number
                | symbol]: Classes[K] extends new (...args: any[]) => U ? U : never
            }[keyof Classes],
        >,
        { key: Keys; args: Args },
    >

    Type Parameters

    • Keys extends string
    • Values extends new (...args: any[]) => any
    • Classes extends Record<Keys, Values>
    • Args extends any[]

    Parameters

    Returns Transform<
        Simplify<
            {
                [K in string
                | number
                | symbol]: Classes[K] extends new (...args: any[]) => U ? U : never
            }[keyof Classes],
        >,
        { key: Keys; args: Args },
    >

Settings

Member Visibility
+makeClassGroupTransform | extended-serializer

Function makeClassGroupTransform

  • makeClassGroupTransform<
        Keys extends string,
        Values extends new (...args: any[]) => any,
        Classes extends Record<Keys, Values>,
        Args extends any[],
    >(
        __namedParameters: MakeClassGroupTransformOptions<
            Keys,
            Values,
            Classes,
            Args,
        >,
    ): Transform<
        Simplify<
            {
                [K in string
                | number
                | symbol]: Classes[K] extends new (...args: any[]) => U ? U : never
            }[keyof Classes],
        >,
        { key: Keys; args: Args },
    >

    Type Parameters

    • Keys extends string
    • Values extends new (...args: any[]) => any
    • Classes extends Record<Keys, Values>
    • Args extends any[]

    Parameters

    Returns Transform<
        Simplify<
            {
                [K in string
                | number
                | symbol]: Classes[K] extends new (...args: any[]) => U ? U : never
            }[keyof Classes],
        >,
        { key: Keys; args: Args },
    >

Settings

Member Visibility
diff --git a/docs/functions/makeClassTransform.html b/docs/functions/makeClassTransform.html index 3069468..0d31874 100644 --- a/docs/functions/makeClassTransform.html +++ b/docs/functions/makeClassTransform.html @@ -1 +1 @@ -makeClassTransform | extended-serializer

Function makeClassTransform

Settings

Member Visibility
+makeClassTransform | extended-serializer

Function makeClassTransform

Settings

Member Visibility
diff --git a/docs/functions/makeScopedTransform.html b/docs/functions/makeScopedTransform.html index 0e59059..d964c2c 100644 --- a/docs/functions/makeScopedTransform.html +++ b/docs/functions/makeScopedTransform.html @@ -1 +1 @@ -makeScopedTransform | extended-serializer

Function makeScopedTransform

Settings

Member Visibility
+makeScopedTransform | extended-serializer

Function makeScopedTransform

Settings

Member Visibility
diff --git a/docs/functions/makeTransform.html b/docs/functions/makeTransform.html index 91a3a48..de89296 100644 --- a/docs/functions/makeTransform.html +++ b/docs/functions/makeTransform.html @@ -1 +1 @@ -makeTransform | extended-serializer

Function makeTransform

Settings

Member Visibility
+makeTransform | extended-serializer

Function makeTransform

Settings

Member Visibility
diff --git a/docs/functions/makeValueGroupTransform.html b/docs/functions/makeValueGroupTransform.html index 94e3d1c..9ff240f 100644 --- a/docs/functions/makeValueGroupTransform.html +++ b/docs/functions/makeValueGroupTransform.html @@ -1 +1 @@ -makeValueGroupTransform | extended-serializer

Function makeValueGroupTransform

Settings

Member Visibility
+makeValueGroupTransform | extended-serializer

Function makeValueGroupTransform

Settings

Member Visibility
diff --git a/docs/functions/objectMap.html b/docs/functions/objectMap.html index be1bf55..c90cf76 100644 --- a/docs/functions/objectMap.html +++ b/docs/functions/objectMap.html @@ -1 +1 @@ -objectMap | extended-serializer

Function objectMap

  • objectMap<T, U>(
        obj: Record<string | number | symbol, T>,
        fn: (value: T) => U,
    ): Record<string | number | symbol, U>

    Type Parameters

    • T
    • U

    Parameters

    • obj: Record<string | number | symbol, T>
    • fn: (value: T) => U

    Returns Record<string | number | symbol, U>

Settings

Member Visibility
+objectMap | extended-serializer

Function objectMap

  • objectMap<T, U>(
        obj: Record<string | number | symbol, T>,
        fn: (value: T) => U,
    ): Record<string | number | symbol, U>

    Type Parameters

    • T
    • U

    Parameters

    • obj: Record<string | number | symbol, T>
    • fn: (value: T) => U

    Returns Record<string | number | symbol, U>

Settings

Member Visibility
diff --git a/docs/functions/parse.html b/docs/functions/parse.html index 1594c71..8095a28 100644 --- a/docs/functions/parse.html +++ b/docs/functions/parse.html @@ -1,2 +1,2 @@ parse | extended-serializer

Function parse

Acts as a drop in replacement for JSON.parse, with decoder built in.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/stringify.html b/docs/functions/stringify.html index a1fcd7d..c25d4cd 100644 --- a/docs/functions/stringify.html +++ b/docs/functions/stringify.html @@ -1,2 +1,2 @@ stringify | extended-serializer

Function stringify

Acts as a drop in replacement for JSON.stringify, with encoder built in.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 50c2859..ac9a4ba 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,6 @@ extended-serializer

extended-serializer

Extended Serializer

Install

npm install extended-serializer

About

    +
  • link to documentation
  • Extends JSON serialization to support almost all data types.
  • Validates all input data to ensure that it is serializable.
  • Doesn't rely on a nonce like other solutions, so no chance of collisions.
    • diff --git a/docs/types/BuiltTransform.html b/docs/types/BuiltTransform.html index 278f8c1..2366f40 100644 --- a/docs/types/BuiltTransform.html +++ b/docs/types/BuiltTransform.html @@ -1 +1 @@ -BuiltTransform | extended-serializer

    Type Alias BuiltTransform<T, P, K>

    BuiltTransform: { key: string; test: TransformTest<T> } & (
        K extends "encode"
            ? { encode: TransformEncode<T, P> }
            : { decode: TransformDecode<T, P> }
    )

    Type Parameters

    • T
    • P
    • K extends "encode" | "decode"

    Settings

    Member Visibility
    +BuiltTransform | extended-serializer

    Type Alias BuiltTransform<T, P, K>

    BuiltTransform: { key: string; test: TransformTest<T> } & (
        K extends "encode"
            ? { encode: TransformEncode<T, P> }
            : { decode: TransformDecode<T, P> }
    )

    Type Parameters

    • T
    • P
    • K extends "encode" | "decode"

    Settings

    Member Visibility
    diff --git a/docs/types/InstanceOfClassInRecord.html b/docs/types/InstanceOfClassInRecord.html index e3e4872..257184a 100644 --- a/docs/types/InstanceOfClassInRecord.html +++ b/docs/types/InstanceOfClassInRecord.html @@ -1 +1 @@ -InstanceOfClassInRecord | extended-serializer

    Type Alias InstanceOfClassInRecord<T>

    InstanceOfClassInRecord: Simplify<
        {
            [K in keyof T]: T[K] extends new (...args: any[]) => infer U
                ? U
                : never
        }[keyof T],
    >

    Type Parameters

    • T

    Settings

    Member Visibility
    +InstanceOfClassInRecord | extended-serializer

    Type Alias InstanceOfClassInRecord<T>

    InstanceOfClassInRecord: Simplify<
        {
            [K in keyof T]: T[K] extends new (...args: any[]) => infer U
                ? U
                : never
        }[keyof T],
    >

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/docs/types/MakeClassGroupTransformOptions.html b/docs/types/MakeClassGroupTransformOptions.html index 23ea2b7..dd870f2 100644 --- a/docs/types/MakeClassGroupTransformOptions.html +++ b/docs/types/MakeClassGroupTransformOptions.html @@ -2,4 +2,4 @@
  • classes: Classes

    Object of classes to capture

  • Optionalencode?: TransformEncode<InstanceOfClassInRecord<Classes>, Args>

    Will return and empty array if not provided

  • Optionaldecode?: (constructor: Values, args: Args) => InstanceOfClassInRecord<Classes>

    Will construct an instance of constructor with value spread as parameters if not provided

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/MakeClassTransformOptions.html b/docs/types/MakeClassTransformOptions.html index 0258459..f1b2447 100644 --- a/docs/types/MakeClassTransformOptions.html +++ b/docs/types/MakeClassTransformOptions.html @@ -2,4 +2,4 @@
  • constructor: new (...args: any[]) => T

    Class to capture

  • Optionalencode?: TransformEncode<T, P>

    Will return and empty array if not provided

  • Optionaldecode?: TransformDecode<T, P>

    Will construct an instance of constructor with value spread as parameters if not provided

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/MakeScopedTransformOptions.html b/docs/types/MakeScopedTransformOptions.html index 4105319..61a6ec7 100644 --- a/docs/types/MakeScopedTransformOptions.html +++ b/docs/types/MakeScopedTransformOptions.html @@ -2,4 +2,4 @@
  • test: TransformTest<T>

    Capture test for this transform

  • Optionalencode?: TransformMakeEncode<T, P>

    Returns function used to encode

  • Optionaldecode?: TransformMakeDecode<T, P>

    Returns function used to decode

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/MakeTransformOptions.html b/docs/types/MakeTransformOptions.html index 726e4da..e1c204f 100644 --- a/docs/types/MakeTransformOptions.html +++ b/docs/types/MakeTransformOptions.html @@ -2,4 +2,4 @@
  • test: TransformTest<T>

    Capture test for this transform

  • Optionalencode?: TransformEncode<T, P>

    Encodes value to a primitive representation

  • Optionaldecode?: TransformDecode<T, P>

    Decodes back to original value

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/MakeValueGroupTransformOptions.html b/docs/types/MakeValueGroupTransformOptions.html index 581469d..07211dc 100644 --- a/docs/types/MakeValueGroupTransformOptions.html +++ b/docs/types/MakeValueGroupTransformOptions.html @@ -1,3 +1,3 @@ MakeValueGroupTransformOptions | extended-serializer

    Type Alias MakeValueGroupTransformOptions<Keys, Values>

    MakeValueGroupTransformOptions: { key: string; values: Values }

    Type Parameters

    • Keys extends string
    • Values extends Record<Keys, unknown>

    Type declaration

    • key: string

      The key used internally when encoding and decoding

    • values: Values

      Object of values to capture

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/Primitive.html b/docs/types/Primitive.html index e94485f..4379cd7 100644 --- a/docs/types/Primitive.html +++ b/docs/types/Primitive.html @@ -1 +1 @@ -Primitive | extended-serializer

    Type Alias Primitive<Extra>

    Primitive:
        | null
        | boolean
        | number
        | string
        | Extra
        | Primitive<Extra>[]
        | { [key: string]: Primitive<Extra> }

    Type Parameters

    • Extra = never

    Settings

    Member Visibility
    +Primitive | extended-serializer

    Type Alias Primitive<Extra>

    Primitive:
        | null
        | boolean
        | number
        | string
        | Extra
        | Primitive<Extra>[]
        | { [key: string]: Primitive<Extra> }

    Type Parameters

    • Extra = never

    Settings

    Member Visibility
    diff --git a/docs/types/SerializeOptions.html b/docs/types/SerializeOptions.html index 2e0c36d..de7a6e2 100644 --- a/docs/types/SerializeOptions.html +++ b/docs/types/SerializeOptions.html @@ -1,4 +1,4 @@ SerializeOptions | extended-serializer

    Type Alias SerializeOptions

    SerializeOptions: {
        tag?: string;
        transforms?: Transform<any, any>[];
        validate?: (value: unknown) => boolean;
    }

    Type declaration

    • Optionaltag?: string

      The tag used internally when encoding and decoding

    • Optionaltransforms?: Transform<any, any>[]

      The transforms to be used when encoding and decoding

    • Optionalvalidate?: (value: unknown) => boolean

      Extra validation on values before encoding

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/Shape.html b/docs/types/Shape.html index 1e9e451..c63f624 100644 --- a/docs/types/Shape.html +++ b/docs/types/Shape.html @@ -1 +1 @@ -Shape | extended-serializer

    Type Alias Shape

    Shape: [string, string, Primitive]

    Settings

    Member Visibility
    +Shape | extended-serializer

    Type Alias Shape

    Shape: [string, string, Primitive]

    Settings

    Member Visibility
    diff --git a/docs/types/ShapeLike.html b/docs/types/ShapeLike.html index aed9cf9..c8ebbf6 100644 --- a/docs/types/ShapeLike.html +++ b/docs/types/ShapeLike.html @@ -1 +1 @@ -ShapeLike | extended-serializer

    Type Alias ShapeLike

    ShapeLike: [string, ...Primitive[]]

    Settings

    Member Visibility
    +ShapeLike | extended-serializer

    Type Alias ShapeLike

    ShapeLike: [string, ...Primitive[]]

    Settings

    Member Visibility
    diff --git a/docs/types/Transform.html b/docs/types/Transform.html index d38fc9e..6f1d001 100644 --- a/docs/types/Transform.html +++ b/docs/types/Transform.html @@ -1 +1 @@ -Transform | extended-serializer

    Type Alias Transform<T, P>

    Transform: {
        key: string;
        test: TransformTest<T>;
        encode?: TransformEncode<T, P>;
        decode?: TransformDecode<T, P>;
        makeEncode?: TransformMakeEncode<T, P>;
        makeDecode?: TransformMakeDecode<T, P>;
    }

    Type Parameters

    • T
    • P

    Type declaration

    • key: string
    • test: TransformTest<T>
    • Optionalencode?: TransformEncode<T, P>
    • Optionaldecode?: TransformDecode<T, P>
    • OptionalmakeEncode?: TransformMakeEncode<T, P>
    • OptionalmakeDecode?: TransformMakeDecode<T, P>

    Settings

    Member Visibility
    +Transform | extended-serializer

    Type Alias Transform<T, P>

    Transform: {
        key: string;
        test: TransformTest<T>;
        encode?: TransformEncode<T, P>;
        decode?: TransformDecode<T, P>;
        makeEncode?: TransformMakeEncode<T, P>;
        makeDecode?: TransformMakeDecode<T, P>;
    }

    Type Parameters

    • T
    • P

    Type declaration

    • key: string
    • test: TransformTest<T>
    • Optionalencode?: TransformEncode<T, P>
    • Optionaldecode?: TransformDecode<T, P>
    • OptionalmakeEncode?: TransformMakeEncode<T, P>
    • OptionalmakeDecode?: TransformMakeDecode<T, P>

    Settings

    Member Visibility
    diff --git a/docs/types/TransformedPrimitive.html b/docs/types/TransformedPrimitive.html index 614f9ad..6cf5af8 100644 --- a/docs/types/TransformedPrimitive.html +++ b/docs/types/TransformedPrimitive.html @@ -1 +1 @@ -TransformedPrimitive | extended-serializer

    Type Alias TransformedPrimitive<Extra>

    TransformedPrimitive: Primitive<
        | undefined
        | bigint
        | symbol
        | Set<TransformedPrimitive<Extra>>
        | Map<TransformedPrimitive<Extra>, TransformedPrimitive<Extra>>
        | Date
        | RegExp
        | ArrayBuffer
        | DataView
        | Boolean
        | Number
        | String
        | Error
        | EvalError
        | RangeError
        | ReferenceError
        | SyntaxError
        | TypeError
        | URIError
        | AggregateError
        | Int8Array
        | Uint8Array
        | Uint8ClampedArray
        | Int16Array
        | Uint16Array
        | Int32Array
        | Uint32Array
        | Float32Array
        | Float64Array
        | BigInt64Array
        | BigUint64Array
        | { [key: string | number | symbol]: TransformedPrimitive<Extra> },
    >

    Type Parameters

    • Extra = never

    Settings

    Member Visibility
    +TransformedPrimitive | extended-serializer

    Type Alias TransformedPrimitive<Extra>

    TransformedPrimitive: Primitive<
        | undefined
        | bigint
        | symbol
        | Set<TransformedPrimitive<Extra>>
        | Map<TransformedPrimitive<Extra>, TransformedPrimitive<Extra>>
        | Date
        | RegExp
        | ArrayBuffer
        | DataView
        | Boolean
        | Number
        | String
        | Error
        | EvalError
        | RangeError
        | ReferenceError
        | SyntaxError
        | TypeError
        | URIError
        | AggregateError
        | Int8Array
        | Uint8Array
        | Uint8ClampedArray
        | Int16Array
        | Uint16Array
        | Int32Array
        | Uint32Array
        | Float32Array
        | Float64Array
        | BigInt64Array
        | BigUint64Array
        | { [key: string | number | symbol]: TransformedPrimitive<Extra> },
    >

    Type Parameters

    • Extra = never

    Settings

    Member Visibility
    diff --git a/docs/types/Validate.html b/docs/types/Validate.html index e1c7cc6..71258ab 100644 --- a/docs/types/Validate.html +++ b/docs/types/Validate.html @@ -1 +1 @@ -Validate | extended-serializer

    Type Alias Validate

    Validate: (value: unknown) => asserts value is Primitive

    Type declaration

      • (value: unknown): asserts value is Primitive

      • Parameters

        • value: unknown

        Returns asserts value is Primitive

    Settings

    Member Visibility
    +Validate | extended-serializer

    Type Alias Validate

    Validate: (value: unknown) => asserts value is Primitive

    Type declaration

      • (value: unknown): asserts value is Primitive

      • Parameters

        • value: unknown

        Returns asserts value is Primitive

    Settings

    Member Visibility
    diff --git a/docs/variables/arrayBufferTransform.html b/docs/variables/arrayBufferTransform.html index 7602002..f504022 100644 --- a/docs/variables/arrayBufferTransform.html +++ b/docs/variables/arrayBufferTransform.html @@ -1 +1 @@ -arrayBufferTransform | extended-serializer

    Variable arrayBufferTransformConst

    arrayBufferTransform: Transform<ArrayBuffer, [number, number, number[]]> = ...

    Settings

    Member Visibility
    +arrayBufferTransform | extended-serializer

    Variable arrayBufferTransformConst

    arrayBufferTransform: Transform<ArrayBuffer, [number, number, number[]]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/bigIntTransform.html b/docs/variables/bigIntTransform.html index 4979c43..ea3a622 100644 --- a/docs/variables/bigIntTransform.html +++ b/docs/variables/bigIntTransform.html @@ -1 +1 @@ -bigIntTransform | extended-serializer

    Variable bigIntTransformConst

    bigIntTransform: Transform<bigint, string> = ...

    Settings

    Member Visibility
    +bigIntTransform | extended-serializer

    Variable bigIntTransformConst

    bigIntTransform: Transform<bigint, string> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/complexArrayTransform.html b/docs/variables/complexArrayTransform.html index ec5e208..f5e8a65 100644 --- a/docs/variables/complexArrayTransform.html +++ b/docs/variables/complexArrayTransform.html @@ -1 +1 @@ -complexArrayTransform | extended-serializer

    Variable complexArrayTransformConst

    complexArrayTransform: Transform<
        unknown[],
        TypedPropertyDescriptor<unknown>[] & { [x: string]: PropertyDescriptor },
    > = ...

    Settings

    Member Visibility
    +complexArrayTransform | extended-serializer

    Variable complexArrayTransformConst

    complexArrayTransform: Transform<
        unknown[],
        TypedPropertyDescriptor<unknown>[] & { [x: string]: PropertyDescriptor },
    > = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/complexObjectTransform.html b/docs/variables/complexObjectTransform.html index 16ea40c..2e26a7f 100644 --- a/docs/variables/complexObjectTransform.html +++ b/docs/variables/complexObjectTransform.html @@ -1 +1 @@ -complexObjectTransform | extended-serializer

    Variable complexObjectTransformConst

    complexObjectTransform: Transform<
        Record<string | number | symbol, unknown>,
        (
            | [string, TypedPropertyDescriptor<unknown>]
            | (undefined | symbol | TypedPropertyDescriptor<unknown>)[]
        )[],
    > = ...

    Settings

    Member Visibility
    +complexObjectTransform | extended-serializer

    Variable complexObjectTransformConst

    complexObjectTransform: Transform<
        Record<string | number | symbol, unknown>,
        (
            | [string, TypedPropertyDescriptor<unknown>]
            | (undefined | symbol | TypedPropertyDescriptor<unknown>)[]
        )[],
    > = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/dataViewTransform.html b/docs/variables/dataViewTransform.html index 71e9b82..69ba259 100644 --- a/docs/variables/dataViewTransform.html +++ b/docs/variables/dataViewTransform.html @@ -1 +1 @@ -dataViewTransform | extended-serializer

    Variable dataViewTransformConst

    dataViewTransform: Transform<DataView<ArrayBufferLike>, any[]> = ...

    Settings

    Member Visibility
    +dataViewTransform | extended-serializer

    Variable dataViewTransformConst

    dataViewTransform: Transform<DataView<ArrayBufferLike>, any[]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/dateTransform.html b/docs/variables/dateTransform.html index 3bf13fe..9082257 100644 --- a/docs/variables/dateTransform.html +++ b/docs/variables/dateTransform.html @@ -1 +1 @@ -dateTransform | extended-serializer

    Variable dateTransformConst

    dateTransform: Transform<Date, string[] | number[]> = ...

    Settings

    Member Visibility
    +dateTransform | extended-serializer

    Variable dateTransformConst

    dateTransform: Transform<Date, string[] | number[]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/errorClassTransform.html b/docs/variables/errorClassTransform.html index 3773cf8..1ca7ffb 100644 --- a/docs/variables/errorClassTransform.html +++ b/docs/variables/errorClassTransform.html @@ -1 +1 @@ -errorClassTransform | extended-serializer

    Variable errorClassTransformConst

    errorClassTransform: Transform<
        Simplify<Error | AggregateError>,
        { key: string; args: unknown[] },
    > = ...

    Settings

    Member Visibility
    +errorClassTransform | extended-serializer

    Variable errorClassTransformConst

    errorClassTransform: Transform<
        Simplify<Error | AggregateError>,
        { key: string; args: unknown[] },
    > = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/infinityTransform.html b/docs/variables/infinityTransform.html index 5bbcec9..a8cd2f9 100644 --- a/docs/variables/infinityTransform.html +++ b/docs/variables/infinityTransform.html @@ -1 +1 @@ -infinityTransform | extended-serializer

    Variable infinityTransformConst

    infinityTransform: Transform<number, number> = ...

    Settings

    Member Visibility
    +infinityTransform | extended-serializer

    Variable infinityTransformConst

    infinityTransform: Transform<number, number> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/mapTransform.html b/docs/variables/mapTransform.html index d4af01f..4b599f7 100644 --- a/docs/variables/mapTransform.html +++ b/docs/variables/mapTransform.html @@ -1 +1 @@ -mapTransform | extended-serializer

    Variable mapTransformConst

    mapTransform: Transform<Map<unknown, unknown>, [unknown, unknown][][]> = ...

    Settings

    Member Visibility
    +mapTransform | extended-serializer

    Variable mapTransformConst

    mapTransform: Transform<Map<unknown, unknown>, [unknown, unknown][][]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/nanTransform.html b/docs/variables/nanTransform.html index 83ca200..e3cf998 100644 --- a/docs/variables/nanTransform.html +++ b/docs/variables/nanTransform.html @@ -1 +1 @@ -nanTransform | extended-serializer

    Variable nanTransformConst

    nanTransform: Transform<number, null> = ...

    Settings

    Member Visibility
    +nanTransform | extended-serializer

    Variable nanTransformConst

    nanTransform: Transform<number, null> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/negativeZeroTransform.html b/docs/variables/negativeZeroTransform.html index fd63ddf..f7b4de1 100644 --- a/docs/variables/negativeZeroTransform.html +++ b/docs/variables/negativeZeroTransform.html @@ -1 +1 @@ -negativeZeroTransform | extended-serializer

    Variable negativeZeroTransformConst

    negativeZeroTransform: Transform<number, null> = ...

    Settings

    Member Visibility
    +negativeZeroTransform | extended-serializer

    Variable negativeZeroTransformConst

    negativeZeroTransform: Transform<number, null> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/primitiveClassTransform.html b/docs/variables/primitiveClassTransform.html index be3440d..338eab0 100644 --- a/docs/variables/primitiveClassTransform.html +++ b/docs/variables/primitiveClassTransform.html @@ -1 +1 @@ -primitiveClassTransform | extended-serializer

    Variable primitiveClassTransformConst

    primitiveClassTransform: Transform<
        Simplify<String | Number | Boolean>,
        { key: string; args: (string | number | boolean)[] },
    > = ...

    Settings

    Member Visibility
    +primitiveClassTransform | extended-serializer

    Variable primitiveClassTransformConst

    primitiveClassTransform: Transform<
        Simplify<String | Number | Boolean>,
        { key: string; args: (string | number | boolean)[] },
    > = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/regExpTransform.html b/docs/variables/regExpTransform.html index 9963703..349b01d 100644 --- a/docs/variables/regExpTransform.html +++ b/docs/variables/regExpTransform.html @@ -1 +1 @@ -regExpTransform | extended-serializer

    Variable regExpTransformConst

    regExpTransform: Transform<RegExp, [string, string, number]> = ...

    Settings

    Member Visibility
    +regExpTransform | extended-serializer

    Variable regExpTransformConst

    regExpTransform: Transform<RegExp, [string, string, number]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/registrySymbolTransform.html b/docs/variables/registrySymbolTransform.html index 04ee9c4..ff1a4c1 100644 --- a/docs/variables/registrySymbolTransform.html +++ b/docs/variables/registrySymbolTransform.html @@ -1 +1 @@ -registrySymbolTransform | extended-serializer

    Variable registrySymbolTransformConst

    registrySymbolTransform: Transform<symbol, string> = ...

    Settings

    Member Visibility
    +registrySymbolTransform | extended-serializer

    Variable registrySymbolTransformConst

    registrySymbolTransform: Transform<symbol, string> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/setTransform.html b/docs/variables/setTransform.html index e1244e6..8ae9594 100644 --- a/docs/variables/setTransform.html +++ b/docs/variables/setTransform.html @@ -1 +1 @@ -setTransform | extended-serializer

    Variable setTransformConst

    setTransform: Transform<Set<unknown>, unknown[][]> = ...

    Settings

    Member Visibility
    +setTransform | extended-serializer

    Variable setTransformConst

    setTransform: Transform<Set<unknown>, unknown[][]> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/transforms.html b/docs/variables/transforms.html index e156a0f..dd98987 100644 --- a/docs/variables/transforms.html +++ b/docs/variables/transforms.html @@ -1,2 +1,2 @@ transforms | extended-serializer

    Variable transformsConst

    transforms: (
        | Transform<ArrayBuffer, [number, number, number[]]>
        | Transform<bigint, string>
        | Transform<
            unknown[],
            TypedPropertyDescriptor<unknown>[] & { [x: string]: PropertyDescriptor },
        >
        | Transform<
            Record<string | number | symbol, unknown>,
            (
                | [string, TypedPropertyDescriptor<unknown>]
                | (undefined | symbol | TypedPropertyDescriptor<unknown>)[]
            )[],
        >
        | Transform<DataView<ArrayBufferLike>, any[]>
        | Transform<Date, string[] | number[]>
        | Transform<
            Simplify<Error | AggregateError>,
            { key: string; args: unknown[] },
        >
        | Transform<number, number>
        | Transform<Map<unknown, unknown>, [unknown, unknown][][]>
        | Transform<number, null>
        | Transform<
            Simplify<String | Number | Boolean>,
            { key: string; args: (string | number | boolean)[] },
        >
        | Transform<RegExp, [string, string, number]>
        | Transform<symbol, string>
        | Transform<Set<unknown>, unknown[][]>
        | Transform<
            Simplify<
                | Int8Array<ArrayBuffer>
                | Uint8Array<ArrayBuffer>
                | Uint8ClampedArray<ArrayBuffer>
                | Int16Array<ArrayBuffer>
                | Uint16Array<ArrayBuffer>
                | Int32Array<ArrayBuffer>
                | Uint32Array<ArrayBuffer>
                | Float32Array<ArrayBuffer>
                | Float64Array<ArrayBuffer>
                | BigInt64Array<ArrayBuffer>
                | BigUint64Array<ArrayBuffer>,
            >,
            { key: string; args: ArrayBuffer[] },
        >
        | Transform<undefined, null>
        | Transform<unknown, string>
    )[] = ...

    An array containing all the built-in transforms.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/variables/typedArrayTransform.html b/docs/variables/typedArrayTransform.html index 24ef1f1..ee0e75d 100644 --- a/docs/variables/typedArrayTransform.html +++ b/docs/variables/typedArrayTransform.html @@ -1 +1 @@ -typedArrayTransform | extended-serializer

    Variable typedArrayTransformConst

    typedArrayTransform: Transform<
        Simplify<
            | Int8Array<ArrayBuffer>
            | Uint8Array<ArrayBuffer>
            | Uint8ClampedArray<ArrayBuffer>
            | Int16Array<ArrayBuffer>
            | Uint16Array<ArrayBuffer>
            | Int32Array<ArrayBuffer>
            | Uint32Array<ArrayBuffer>
            | Float32Array<ArrayBuffer>
            | Float64Array<ArrayBuffer>
            | BigInt64Array<ArrayBuffer>
            | BigUint64Array<ArrayBuffer>,
        >,
        { key: string; args: ArrayBuffer[] },
    > = ...

    Settings

    Member Visibility
    +typedArrayTransform | extended-serializer

    Variable typedArrayTransformConst

    typedArrayTransform: Transform<
        Simplify<
            | Int8Array<ArrayBuffer>
            | Uint8Array<ArrayBuffer>
            | Uint8ClampedArray<ArrayBuffer>
            | Int16Array<ArrayBuffer>
            | Uint16Array<ArrayBuffer>
            | Int32Array<ArrayBuffer>
            | Uint32Array<ArrayBuffer>
            | Float32Array<ArrayBuffer>
            | Float64Array<ArrayBuffer>
            | BigInt64Array<ArrayBuffer>
            | BigUint64Array<ArrayBuffer>,
        >,
        { key: string; args: ArrayBuffer[] },
    > = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/undefinedTransform.html b/docs/variables/undefinedTransform.html index d3a64a1..de161a3 100644 --- a/docs/variables/undefinedTransform.html +++ b/docs/variables/undefinedTransform.html @@ -1 +1 @@ -undefinedTransform | extended-serializer

    Variable undefinedTransformConst

    undefinedTransform: Transform<undefined, null> = ...

    Settings

    Member Visibility
    +undefinedTransform | extended-serializer

    Variable undefinedTransformConst

    undefinedTransform: Transform<undefined, null> = ...

    Settings

    Member Visibility
    diff --git a/docs/variables/wellKnownSymbolTransform.html b/docs/variables/wellKnownSymbolTransform.html index c0decdd..ff796f4 100644 --- a/docs/variables/wellKnownSymbolTransform.html +++ b/docs/variables/wellKnownSymbolTransform.html @@ -1 +1 @@ -wellKnownSymbolTransform | extended-serializer

    Variable wellKnownSymbolTransformConst

    wellKnownSymbolTransform: Transform<unknown, string> = ...

    Settings

    Member Visibility
    +wellKnownSymbolTransform | extended-serializer

    Variable wellKnownSymbolTransformConst

    wellKnownSymbolTransform: Transform<unknown, string> = ...

    Settings

    Member Visibility
    diff --git a/package.json b/package.json index e389981..244c0e9 100644 --- a/package.json +++ b/package.json @@ -3,16 +3,16 @@ "type": "commonjs", "version": "3.0.0", "description": "", - "main": "dist/esm/src/index.mjs", + "main": "dist/esm/index.mjs", "exports": { ".": { "import": { - "types": "./dist/esm/src/index.d.ts", - "default": "./dist/esm/src/index.js" + "types": "./dist/esm/index.d.ts", + "default": "./dist/esm/index.js" }, "default": { - "types": "./dist/cjs/src/index.d.ts", - "default": "./dist/cjs/src/index.js" + "types": "./dist/cjs/index.d.ts", + "default": "./dist/cjs/index.js" } } },