@sapphire/string-store 1.1.0-next.7c2bed20 → 1.1.0-next.db356eb0

package/dist/esm/index.d.mts

@@ -43,13 +43,21 @@ declare class UnalignedUint16Array {
     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;
@@ -78,6 +86,89 @@ interface IType<ValueType, BitSize extends number | null> {
     readonly BIT_SIZE: BitSize;
 }
 
+declare function ArrayType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>): IType<ValueType[], null>;
+
+declare const BigInt32Type: IType<bigint, 32>;
+
+declare const BigInt64Type: IType<bigint, 64>;
+
+declare const BigUint32Type: IType<bigint, 32>;
+
+declare const BigUint64Type: IType<bigint, 64>;
+
+declare const BitType: IType<number, 1>;
+
+declare const BooleanType: IType<boolean, 1>;
+
+declare function FixedLengthArrayType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>, length: number): IType<ValueType[], ValueBitSize extends null ? null : number>;
+
+declare const Float32Type: IType<number, 32>;
+
+declare const Float64Type: IType<number, 64>;
+
+declare const Int16Type: IType<number, 16>;
+
+declare const Int2Type: IType<number, 2>;
+
+declare const Int32Type: IType<number, 32>;
+
+declare const Int4Type: IType<number, 4>;
+
+declare const Int64Type: IType<number, 64>;
+
+declare const Int8Type: IType<number, 8>;
+
+declare const SnowflakeType: {
+    readonly serialize: (buffer: UnalignedUint16Array, value: bigint | string) => void;
+    readonly deserialize: (buffer: UnalignedUint16Array, offset: Pointer) => bigint;
+    readonly BIT_SIZE: 64;
+};
+
+declare const StringType: IType<string, null>;
+
+declare const Uint16Type: IType<number, 16>;
+
+declare const Uint2Type: IType<number, 2>;
+
+declare const Uint32Type: IType<number, 32>;
+
+declare const Uint4Type: IType<number, 4>;
+
+declare const Uint64Type: IType<number, 64>;
+
+declare const Uint8Type: IType<number, 8>;
+
+declare const t: {
+    array: typeof ArrayType;
+    bigInt32: IType<bigint, 32>;
+    bigInt64: IType<bigint, 64>;
+    bigUint32: IType<bigint, 32>;
+    bigUint64: IType<bigint, 64>;
+    bit: IType<number, 1>;
+    boolean: IType<boolean, 1>;
+    fixedLengthArray: typeof FixedLengthArrayType;
+    float32: IType<number, 32>;
+    float64: IType<number, 64>;
+    int16: IType<number, 16>;
+    int2: IType<number, 2>;
+    int32: IType<number, 32>;
+    int4: IType<number, 4>;
+    int64: IType<number, 64>;
+    int8: IType<number, 8>;
+    snowflake: {
+        readonly serialize: (buffer: UnalignedUint16Array, value: string | bigint) => void;
+        readonly deserialize: (buffer: UnalignedUint16Array, offset: Pointer) => bigint;
+        readonly BIT_SIZE: 64;
+    };
+    string: IType<string, null>;
+    uint16: IType<number, 16>;
+    uint2: IType<number, 2>;
+    uint32: IType<number, 32>;
+    uint4: IType<number, 4>;
+    uint64: IType<number, 64>;
+    uint8: IType<number, 8>;
+};
+
 declare class Schema<Id extends number = number, Entries extends object = object> {
     #private;
     /**
@@ -180,62 +271,190 @@ declare class Schema<Id extends number = number, Entries extends object = object
     /**
      * Adds a 2-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -2 to 1, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2>>;
+    /**
+     * Adds a 2-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 3, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2>>;
     /**
      * Adds a 4-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -8 to 7, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4>>;
+    /**
+     * Adds a 4-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 15, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4>>;
     /**
      * Adds a 8-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -128 to 127, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8>>;
+    /**
+     * Adds a 8-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 255, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8>>;
     /**
      * Adds a 16-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -32768 to 32767, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16>>;
+    /**
+     * Adds a 16-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 65535, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16>>;
     /**
      * Adds a 32-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -2_147_483_648 to 2_147_483_647, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32>>;
+    /**
+     * Adds a 32-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 4_294_967_295, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32>>;
     /**
      * Adds a 64-bit integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -9_223_372_036_854_775_808 to 9_223_372_036_854_775_807, inclusive.
+     *
+     * However, it may run into precision issues past the range of `-9_007_199_254_740_991` to `9_007_199_254_740_991`
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     int64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
+    /**
+     * Adds a 64-bit unsigned integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0 to 18_446_744_073_709_551_615, inclusive.
+     *
+     * However, it may run into precision issues past `9_007_199_254_740_991`
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    uint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
     /**
      * Adds a 32-bit big integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -2_147_483_648n to 2_147_483_647n, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     bigInt32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32>>;
+    /**
+     * Adds a 32-bit big integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0n to 4_294_967_295n, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    bigUint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32>>;
     /**
      * Adds a 64-bit big integer property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -9_223_372_036_854_775_808n to 9_223_372_036_854_775_807n, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     bigInt64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64>>;
+    /**
+     * Adds a 64-bit big integer property to the schema.
+     *
+     * @remarks
+     *
+     * The range of values is from 0n to 18_446_744_073_709_551_615n, inclusive.
+     *
+     * @param name The name of the property
+     * @returns The modified schema
+     */
+    bigUint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64>>;
     /**
      * Adds a 32-bit floating point number property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -3.4028234663852886e+38 to 3.4028234663852886e+38, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
@@ -243,12 +462,20 @@ declare class Schema<Id extends number = number, Entries extends object = object
     /**
      * Adds a 64-bit floating point number property to the schema.
      *
+     * @remarks
+     *
+     * The range of values is from -1.7976931348623157e+308 to 1.7976931348623157e+308, inclusive.
+     *
      * @param name The name of the property
      * @returns The modified schema
      */
     float64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
     /**
-     * Adds a 64-bit big integer property to the schema, similar to {@link Schema.bigInt64}.
+     * Adds a 64-bit big integer property to the schema, similar to {@link Schema.bigUint64}.
+     *
+     * @remarks
+     *
+     * The range of values is from 0n to 18_446_744_073_709_551_615n, inclusive.
      *
      * @param name The name of the property
      * @returns The modified schema
@@ -384,40 +611,20 @@ type DeserializationResult<SchemaStoreEntries extends object> = {
     };
 }[keyof SchemaStoreEntries];
 
-declare function ArrayType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>): IType<ValueType[], null>;
-
-declare const BigInt32Type: IType<bigint, 32>;
-
-declare const BigInt64Type: IType<bigint, 64>;
-
-declare const BitType: IType<number, 1>;
-
-declare const BooleanType: IType<boolean, 1>;
-
-declare function FixedLengthArrayType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>, length: number): IType<ValueType[], ValueBitSize extends null ? null : number>;
-
-declare const Float32Type: IType<number, 32>;
-
-declare const Float64Type: IType<number, 64>;
-
-declare const Int16Type: IType<number, 16>;
-
-declare const Int2Type: IType<number, 2>;
-
-declare const Int32Type: IType<number, 32>;
-
-declare const Int4Type: IType<number, 4>;
-
-declare const Int64Type: IType<number, 64>;
-
-declare const Int8Type: IType<number, 8>;
-
-declare const SnowflakeType: {
-    readonly serialize: (buffer: UnalignedUint16Array, value: bigint | string) => void;
-    readonly deserialize: (buffer: UnalignedUint16Array, offset: Pointer) => bigint;
-    readonly BIT_SIZE: 64;
-};
-
-declare const StringType: IType<string, null>;
+type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+/**
+ * Converts a {@link TypedArray} to a string.
+ *
+ * @param buffer The buffer to convert
+ * @returns The generated UTF16 string
+ */
+declare function toUTF16(buffer: TypedArray): string;
+/**
+ * Converts a string to a {@link Uint16Array}.
+ *
+ * @param buffer The string to convert
+ * @returns The generated {@link Uint16Array}
+ */
+declare function fromUTF16(buffer: string): Uint16Array;
 
-export { ArrayType, BigInt32Type, BigInt64Type, BitType, BooleanType, type DeserializationResult, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, Pointer, type PointerLike, Schema, SchemaStore, SnowflakeType, StringType, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore };
+export { ArrayType, BigInt32Type, BigInt64Type, BigUint32Type, BigUint64Type, BitType, BooleanType, type DeserializationResult, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, Pointer, type PointerLike, Schema, SchemaStore, SnowflakeType, StringType, type TypedArray, Uint16Type, Uint2Type, Uint32Type, Uint4Type, Uint64Type, Uint8Type, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore, fromUTF16, t, toUTF16 };