function s16
s16(endianness?: Endianness): Coder<number>

Creates a coder for 16-bit signed integers.

This function creates a coder that can encode/decode 16-bit signed integers (range -32,768 to 32,767). The endianness parameter determines the byte order used.

Examples

Example 1

import { assertEquals } from "@std/assert";
import { s16 } from "@hertzg/binstruct/numeric";

// Create big-endian and little-endian coders
const s16be = s16("be");
const s16le = s16("le");

// Test data
const testValue = -32768;

// Encode and decode with big-endian
const bufferBE = new Uint8Array(2);
const bytesWrittenBE = s16be.encode(testValue, bufferBE);
const [decodedBE, bytesReadBE] = s16be.decode(bufferBE);

assertEquals(decodedBE, testValue);
assertEquals(bytesWrittenBE, 2);
assertEquals(bytesReadBE, 2);

// Encode and decode with little-endian
const bufferLE = new Uint8Array(2);
const bytesWrittenLE = s16le.encode(testValue, bufferLE);
const [decodedLE, bytesReadLE] = s16le.decode(bufferLE);

assertEquals(decodedLE, testValue);
assertEquals(bytesWrittenLE, 2);
assertEquals(bytesReadLE, 2);

Parameters

optional
endianness: Endianness = be

The byte order to use ("be" for big-endian, "le" for little-endian), defaults to "be"

Return Type

Coder<number>

A Coder<number> for 16-bit signed integers

Usage

import { s16 } from "numeric/numeric.ts";