@nhtio/encoder 0.1.0-master-ab456424

package/index.d.ts

@@ -0,0 +1,27 @@
+import type { Encodable } from './private/types';
+/**
+ * The current version of the package.
+ *
+ * @tip This is a constant that is replaced during the build process with the actual version of the package.
+ */
+export declare const version: string;
+/**
+ * Encodes a value into a compressed base64 string
+ * @param what The value to be encoded
+ * @returns A compressed base64 string representing the encoded value
+ * @throws {@link @nhtio/encoder/exceptions!E_ENCODING_FAILED | E_ENCODING_FAILED} When the value cannot be encoded
+ * @throws {@link @nhtio/encoder/exceptions!E_CIRCULAR_REFERENCE | E_CIRCULAR_REFERENCE} When the value contains dangerous circular references
+ * @throws {@link @nhtio/encoder/exceptions!E_UNENCODABLE_VALUE | E_UNENCODABLE_VALUE} When the value contains unencodable data types
+ */
+export declare const encode: <T extends Encodable = Encodable>(what: T) => string;
+/**
+ * Decodes a compressed base64 string back into a value
+ * @param base64 The compressed base64 string representing an encoded value
+ * @returns The decoded value
+ * @throws {@link @nhtio/encoder/exceptions!E_NOT_AN_ENCODED_VALUE | E_NOT_AN_ENCODED_VALUE} When the provided string is not a valid encoded value
+ * @throws {@link @nhtio/encoder/exceptions!E_INVALID_VERSION | E_INVALID_VERSION} When the encoded value has an invalid version
+ * @throws {@link @nhtio/encoder/exceptions!E_INCOMPATIBLE_VERSION | E_INCOMPATIBLE_VERSION} When the encoded value is from a version that is newer than the decoder version
+ * @throws {@link @nhtio/encoder/exceptions!E_UNDECODABLE_VALUE | E_UNDECODABLE_VALUE} When the encoded value cannot be decoded
+ */
+export declare const decode: <T extends Encodable = Encodable>(base64: string) => T;
+export type { Encodable, EncodablePrimitive, EncodableTypedArray } from './private/types';