@sapphire/string-store

High-capacity raw data storage in UTF-16 strings.

Description

A package that can store large chunks of data in a short UTF-16 string, useful for storing data in length-limited locations such as Discord's custom_id field in message components.

Features

• Written in TypeScript
• Bundled with esbuild so it can be used in NodeJS and browsers
• Offers CommonJS, ESM and UMD bundles
• Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/string-store

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example, const { SchemaStore } = require('@sapphire/string-store') is equivalent to import { SchemaStore } from '@sapphire/string-store'.

// Require the store classes
const { SchemaStore, Schema } = require('@sapphire/string-store');

const Id = {
  AgeUpdate: 0,
  StrengthUpdate: 1,
  Planet: 2,
  User: 3
};

// Create the store
const store = new SchemaStore()
  // Add a schema with an age field stored as a int32:
  // Schema<Id.AgeUpdate, { age: number }>
  .add(new Schema(Id.AgeUpdate).int32('age'))
  // Add a schema with a strength field stored as a float32:
  // Schema<Id.StrengthUpdate, { strength: number }>
  .add(new Schema(Id.StrengthUpdate).float32('strength'));

// Serialize an `Id.AgeUpdate` object into a string containing:
// - The schema ID (0)
// - The age field (20)
const buffer = store.serialize(Id.AgeUpdate, { age: 20 }).toString();

[!Tip] The serialized string is encoded in UTF-16, meaning it can store 16 bits per character. Each type stores a different number of bits, for example, a single character can store:

• 16 booleans
• 8 2-bit integers (0-3)
• 4 4-bit integers (0-15)
• 2 8-bit integers (0-255)
• 1 16-bit integer (0-65535)

As a use-case, Discord's custom_id field in message components can store up to 100 UTF-16 characters, which means it has a storage of 1600 bits, below you can see the supported types and their storage in bits. Keep in mind that the schema ID is stored as a 16-bit integer, and that the property names are not stored.

The schema can be defined using the following methods:

array

Adds an array with a dynamic length to the schema.

// A schema with a single field `names` that is an array of strings:

const schema = new Schema(Id.Planets).array('names', StringType);
// → Schema<Id.Planets, { names: string[] }>

To track the length of the array, it will serialize a 16-bit unsigned integer before the array.

fixedLengthArray

An alternative to array that has a fixed length, will require the exact number of elements to be serialized, but it will save space by not storing the length of the array.

// A schema with a single field `names` that is an array of exactly 3 strings:

const schema = new Schema(Id.Planets).fixedLengthArray('names', StringType, 3);
// → Schema<Id.Planets, { names: [string, string, string] }>

string

Adds a string to the schema.

// A schema with a single field `name` that is a string:

const schema = new Schema(Id.Planet).string('name');
// → Schema<Id.Planets, { name: string }>

The string is serialized as UTF-8, and the length is serialized as a 16-bit unsigned integer before the string.

boolean

Adds a boolean (single bit) to the schema.

// A schema with a single field `isHabitable` that is a boolean:

const schema = new Schema(Id.Planet).boolean('isHabitable');
// → Schema<Id.Planets, { isHabitable: boolean }>

bit

Adds a bit (0 or 1) to the schema. This is a numeric version of boolean.

// A schema with a single field `isHabitable` that is a bit:

const schema = new Schema(Id.Planet).bit('isHabitable');
// → Schema<Id.Planets, { isHabitable: 0 | 1 }>

int2

Adds a 2-bit integer to the schema. It can store values from 0 to 3 (0b11), inclusive.

// A schema with a single field `type` that is a 2-bit integer:

const schema = new Schema(Id.Planet).int2('type');
// → Schema<Id.Planets, { type: 0 | 1 | 2 | 3 }>

int4

Adds a 4-bit integer to the schema. It can store values from 0 to 15 (0b1111), inclusive.

// A schema with a single field `type` that is a 4-bit integer:

const schema = new Schema(Id.Planet).int4('type');
// → Schema<Id.Planets, { type: 0..=15 }>

int8

Adds an 8-bit integer to the schema. It can store values from 0 to 255 (0b1111_1111), inclusive.

// A schema with a single field `type` that is an 8-bit integer:

const schema = new Schema(Id.Planet).int8('type');
// → Schema<Id.Planets, { type: 0..=255 }>

int16

Adds a 16-bit integer to the schema. It can store values from 0 to 65535 (0xFFFF), inclusive.

// A schema with a single field `type` that is a 16-bit integer:

const schema = new Schema(Id.Planet).int16('type');
// → Schema<Id.Planets, { type: 0..=65535 }>

int32

Adds a 32-bit integer to the schema. It can store values from 0 to 4294967295 (0xFFFFFFFF), inclusive.

// A schema with a single field `type` that is a 32-bit integer:

const schema = new Schema(Id.Planet).int32('type');
// → Schema<Id.Planets, { type: 0..=4294967295 }>

int64

Adds a 64-bit integer to the schema. It can store values from 0 to 9007199254740991 (Number.MAX_SAFE_INTEGER), inclusive.

// A schema with a single field `type` that is a 64-bit integer:

const schema = new Schema(Id.Planet).int64('type');
// → Schema<Id.Planets, { type: 0..=9007199254740991 }>

Note: values larger than Number.MAX_SAFE_INTEGER will be truncated.

bigInt32

Alternative to int32 that uses BigInt.

// A schema with a single field `type` that is a 32-bit integer:

const schema = new Schema(Id.Planet).bigInt32('type');
// → Schema<Id.Planets, { type: 0n..=4294967295n }>

bigInt64

Alternative to int64 that uses BigInt.

// A schema with a single field `type` that is a 64-bit integer:

const schema = new Schema(Id.Planet).bigInt64('type');
// → Schema<Id.Planets, { type: 0n..=9007199254740991n }>

float32

Adds a 32-bit floating-point number to the schema.

// A schema with a single field `radius` that is a 32-bit floating-point number:

const schema = new Schema(Id.Planet).float32('radius');
// → Schema<Id.Planets, { radius: number }>

float64

Adds a 64-bit floating-point number to the schema.

// A schema with a single field `radius` that is a 64-bit floating-point number:

const schema = new Schema(Id.Planet).float64('radius');
// → Schema<Id.Planets, { radius: number }>

snowflake

Adds a 64-bit snowflake to the schema.

const schema = new Schema(Id.User).snowflake('id');
// → Schema<Id.User, { id: bigint }>

---

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
Open Collective	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!