function isRef
isRef<T>(value: unknown): value is RefValue<T>

Checks if a value is a reference created by the ref function.

This function is used to distinguish between literal values and references during encoding/decoding operations.

Examples

Example 1

import { assertEquals } from "@std/assert";
import { isRef, ref, u16le } from "@hertzg/binstruct";

// Create a reference
const lengthRef = ref(u16le());
assertEquals(isRef(lengthRef), true);

// Check literal values
assertEquals(isRef(5), false);
assertEquals(isRef("string"), false);
assertEquals(isRef(null), false);
assertEquals(isRef(undefined), false);

Type Parameters

Parameters

value: unknown

The value to check

Return Type

value is RefValue<T>

True if the value is a reference, false otherwise

Usage

import { isRef } from "ref/ref.ts";