@sapphire/string-store 2.0.0-next.598c24a3 → 2.0.0

package/dist/esm/index.d.mts

@@ -23,7 +23,47 @@ type PointerLike = Pointer | {
     [Symbol.toPrimitive](hint: 'number'): number;
 };
 
-declare class UnalignedUint16Array {
+interface DuplexBuffer {
+    at(index: number): number | undefined;
+    get maxLength(): number;
+    get maxBitLength(): number;
+    get length(): number;
+    get bitLength(): number;
+    writeBit(value: number): void;
+    writeInt2(value: number): void;
+    writeInt4(value: number): void;
+    writeInt8(value: number): void;
+    writeInt16(value: number): void;
+    writeInt32(value: number): void;
+    writeInt64(value: number): void;
+    writeBigInt32(value: bigint): void;
+    writeBigInt64(value: bigint): void;
+    writeFloat32(value: number): void;
+    writeFloat64(value: number): void;
+    readBit(offset: PointerLike): 0 | 1;
+    readInt2(offset: PointerLike): number;
+    readUint2(offset: PointerLike): number;
+    readInt4(offset: PointerLike): number;
+    readUint4(offset: PointerLike): number;
+    readInt8(offset: PointerLike): number;
+    readUint8(offset: PointerLike): number;
+    readInt16(offset: PointerLike): number;
+    readUint16(offset: PointerLike): number;
+    readInt32(offset: PointerLike): number;
+    readUint32(offset: PointerLike): number;
+    readInt64(offset: PointerLike): number;
+    readUint64(offset: PointerLike): number;
+    readBigInt32(offset: PointerLike): bigint;
+    readBigUint32(offset: PointerLike): bigint;
+    readBigInt64(offset: PointerLike): bigint;
+    readBigUint64(offset: PointerLike): bigint;
+    readFloat32(offset: PointerLike): number;
+    readFloat64(offset: PointerLike): number;
+    toString(): string;
+    toArray(): Uint16Array;
+}
+
+declare class UnalignedUint16Array implements DuplexBuffer {
     #private;
     constructor(maxLength: number);
     at(index: number): number | undefined;
@@ -63,7 +103,7 @@ declare class UnalignedUint16Array {
     readFloat64(offset: PointerLike): number;
     toString(): string;
     toArray(): Uint16Array;
-    static from(value: string | UnalignedUint16Array): UnalignedUint16Array;
+    static from(value: string | DuplexBuffer): DuplexBuffer;
 }
 
 interface IType<ValueType, BitSize extends number | null, InputValue = ValueType> {
@@ -73,14 +113,14 @@ interface IType<ValueType, BitSize extends number | null, InputValue = ValueType
      * @param buffer The buffer to write to
      * @param value The value to write
      */
-    serialize(buffer: UnalignedUint16Array, value: InputValue): void;
+    serialize(buffer: DuplexBuffer, value: InputValue): void;
     /**
      * Deserialize a value from a buffer.
      *
      * @param buffer The buffer to read from
      * @param pointer The pointer indicating the current position in the buffer
      */
-    deserialize(buffer: UnalignedUint16Array, pointer: Pointer): ValueType;
+    deserialize(buffer: DuplexBuffer, pointer: Pointer): ValueType;
     /**
      * The size of the value in bits, or `null` if the size is variable.
      */
@@ -209,6 +249,24 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * If the property does not exist, an error will be thrown.
      */
     get<const Name extends keyof Entries & string>(name: Name): Entries[Name];
+    /**
+     * Create a buffer and serialize a value into it, then convert it to a string
+     *
+     * @param value The value to serialize into the buffer
+     * @param defaultMaximumArrayLength The default maximum array length, if any
+     * @returns The newly created string.
+     *
+     * @seealso This method calls {@link Schema.serializeRaw} before calling `toString()` to its result.
+     */
+    serialize(value: Readonly<SerializeValueEntries<Entries>>, defaultMaximumArrayLength?: number): string;
+    /**
+     * Create a buffer and serialize a value into it.
+     *
+     * @param value The value to serialize into the buffer
+     * @param defaultMaximumArrayLength The default maximum array length, if any
+     * @returns The newly created buffer.
+     */
+    serializeRaw(value: Readonly<SerializeValueEntries<Entries>>, defaultMaximumArrayLength?: number): DuplexBuffer;
     /**
      * Serialize a value into a buffer.
      *
@@ -220,7 +278,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * The schema's ID is written to the buffer first, followed by each property
      * in the schema.
      */
-    serialize(buffer: UnalignedUint16Array, value: Readonly<SerializeValueEntries<Entries>>): void;
+    serializeInto(buffer: DuplexBuffer, value: Readonly<SerializeValueEntries<Entries>>): void;
     /**
      * Deserialize a value from a buffer.
      *
@@ -230,10 +288,10 @@ declare class Schema<Id extends number = number, Entries extends object = object
      *
      * @remarks
      *
-     * Unlike {@link Schema.serialize}, this method does not read the schema's ID
+     * Unlike {@link Schema.serializeInto}, this method does not read the schema's ID
      * from the buffer, that is reserved for the {@link SchemaStore}.
      */
-    deserialize(buffer: UnalignedUint16Array, pointer: PointerLike): UnwrapSchemaEntries<Entries>;
+    deserialize(buffer: DuplexBuffer | string, pointer: PointerLike): UnwrapSchemaEntries<Entries>;
     /**
      * Adds an array property to the schema.
      *
@@ -604,14 +662,14 @@ declare class SchemaStore<Entries extends object = object> {
      * @param value The value to serialize
      * @returns The serialized buffer
      */
-    serializeRaw<const Id extends KeyOfStore<this>>(id: Id, value: SerializeValue<Entries[Id] & object>): UnalignedUint16Array;
+    serializeRaw<const Id extends KeyOfStore<this>>(id: Id, value: SerializeValue<Entries[Id] & object>): DuplexBuffer;
     /**
      * Deserializes a buffer
      *
      * @param buffer The buffer to deserialize
      * @returns The resolved value, including the id of the schema used for deserialization
      */
-    deserialize(buffer: string | UnalignedUint16Array): DeserializationResult<Entries>;
+    deserialize(buffer: string | DuplexBuffer): DeserializationResult<Entries>;
     /**
      * Gets the serialized ID from a buffer
      *
@@ -622,7 +680,7 @@ declare class SchemaStore<Entries extends object = object> {
      *
      * If an empty value is passed, a {@linkcode RangeError} will be thrown.
      */
-    getIdentifier(buffer: string | UnalignedUint16Array): KeyOfStore<this>;
+    getIdentifier(buffer: string | DuplexBuffer): KeyOfStore<this>;
     /**
      * Iterates over the stores's schema identifiers.
      *
@@ -679,4 +737,4 @@ declare function toUTF16(buffer: TypedArray): string;
  */
 declare function fromUTF16(buffer: string): Uint16Array;
 
-export { ArrayType, BigInt32Type, BigInt64Type, BigUint32Type, BigUint64Type, BitType, BooleanType, ConstantType, type DeserializationResult, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, NullableType, Pointer, type PointerLike, Schema, SchemaStore, type SerializeValue, type SerializeValueEntries, type SerializeValueType, SnowflakeType, StringType, type TypedArray, Uint16Type, Uint2Type, Uint32Type, Uint4Type, Uint64Type, Uint8Type, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore, fromUTF16, t, toUTF16 };
+export { ArrayType, BigInt32Type, BigInt64Type, BigUint32Type, BigUint64Type, BitType, BooleanType, ConstantType, type DeserializationResult, type DuplexBuffer, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, NullableType, Pointer, type PointerLike, Schema, SchemaStore, type SerializeValue, type SerializeValueEntries, type SerializeValueType, SnowflakeType, StringType, type TypedArray, Uint16Type, Uint2Type, Uint32Type, Uint4Type, Uint64Type, Uint8Type, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore, fromUTF16, t, toUTF16 };