function s64
s64(endianness?: Endianness): Coder<bigint>

Creates a coder for 64-bit signed integers.

This function creates a coder that can encode/decode 64-bit signed integers (range -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807). The endianness parameter determines the byte order used. Note that 64-bit integers are returned as bigint to handle the full range.

Examples

Example 1

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

// Create big-endian and little-endian coders
const s64be = s64("be");
const s64le = s64("le");

// Test data
const testValue = -9223372036854775808n;

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

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

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

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

Parameters

optional
endianness: Endianness = be

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

Return Type

Coder<bigint>

A Coder<bigint> for 64-bit signed integers

Usage

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