isFixedSize

Call Signature

isFixedSize<TFrom, TSize>(encoder): encoder is FixedSizeEncoder<TFrom, TSize>

Determines whether the given codec, encoder, or decoder is fixed-size.

A fixed-size object is identified by the presence of a fixedSize property. If this property exists, the object is considered a FixedSizeCodec, FixedSizeEncoder, or FixedSizeDecoder. Otherwise, it is assumed to be a VariableSizeCodec, VariableSizeEncoder, or VariableSizeDecoder.

Type Parameters

Parameters

Returns

encoder is FixedSizeEncoder<TFrom, TSize>

true if the object is fixed-size, false otherwise.

Examples

Checking a fixed-size encoder.

const encoder = getU32Encoder();
isFixedSize(encoder); // true

Checking a variable-size encoder.

const encoder = addEncoderSizePrefix(getUtf8Encoder(), getU32Encoder());
isFixedSize(encoder); // false

Remarks

This function is commonly used to distinguish between fixed-size and variable-size objects at runtime. If you need to enforce this distinction with type assertions, consider using assertIsFixedSize.

See

assertIsFixedSize

Call Signature

isFixedSize<TTo, TSize>(decoder): decoder is FixedSizeDecoder<TTo, TSize>

Determines whether the given codec, encoder, or decoder is fixed-size.

A fixed-size object is identified by the presence of a fixedSize property. If this property exists, the object is considered a FixedSizeCodec, FixedSizeEncoder, or FixedSizeDecoder. Otherwise, it is assumed to be a VariableSizeCodec, VariableSizeEncoder, or VariableSizeDecoder.

Type Parameters

Parameters

Returns

decoder is FixedSizeDecoder<TTo, TSize>

true if the object is fixed-size, false otherwise.

Examples

Checking a fixed-size encoder.

const encoder = getU32Encoder();
isFixedSize(encoder); // true

Checking a variable-size encoder.

const encoder = addEncoderSizePrefix(getUtf8Encoder(), getU32Encoder());
isFixedSize(encoder); // false

Remarks

This function is commonly used to distinguish between fixed-size and variable-size objects at runtime. If you need to enforce this distinction with type assertions, consider using assertIsFixedSize.

See

assertIsFixedSize

Call Signature

isFixedSize<TFrom, TTo, TSize>(codec): codec is FixedSizeCodec<TFrom, TTo, TSize>

Determines whether the given codec, encoder, or decoder is fixed-size.

A fixed-size object is identified by the presence of a fixedSize property. If this property exists, the object is considered a FixedSizeCodec, FixedSizeEncoder, or FixedSizeDecoder. Otherwise, it is assumed to be a VariableSizeCodec, VariableSizeEncoder, or VariableSizeDecoder.

Type Parameters

Parameters

Returns

codec is FixedSizeCodec<TFrom, TTo, TSize>

true if the object is fixed-size, false otherwise.

Examples

Checking a fixed-size encoder.

const encoder = getU32Encoder();
isFixedSize(encoder); // true

Checking a variable-size encoder.

const encoder = addEncoderSizePrefix(getUtf8Encoder(), getU32Encoder());
isFixedSize(encoder); // false

Remarks

This function is commonly used to distinguish between fixed-size and variable-size objects at runtime. If you need to enforce this distinction with type assertions, consider using assertIsFixedSize.

See

assertIsFixedSize

Call Signature

isFixedSize<TSize>(codec): codec is { fixedSize: TSize }

Determines whether the given codec, encoder, or decoder is fixed-size.

A fixed-size object is identified by the presence of a fixedSize property. If this property exists, the object is considered a FixedSizeCodec, FixedSizeEncoder, or FixedSizeDecoder. Otherwise, it is assumed to be a VariableSizeCodec, VariableSizeEncoder, or VariableSizeDecoder.

Type Parameters

Parameters

Returns

codec is { fixedSize: TSize }

true if the object is fixed-size, false otherwise.

Examples

Checking a fixed-size encoder.

const encoder = getU32Encoder();
isFixedSize(encoder); // true

Checking a variable-size encoder.

const encoder = addEncoderSizePrefix(getUtf8Encoder(), getU32Encoder());
isFixedSize(encoder); // false

Remarks

This function is commonly used to distinguish between fixed-size and variable-size objects at runtime. If you need to enforce this distinction with type assertions, consider using assertIsFixedSize.

See

assertIsFixedSize