identity | /mod.ts | ts_brand@0.0.1

function identity

import { identity } from "https://deno.land/x/ts_brand@0.0.1/mod.ts";

identity<B extends AnyBrand>(underlying: BaseOf<B>): B

A generic function that, when given some branded type, can take a value with the base type of the branded type, and cast that value to the branded type. It fulfills the contract of a Brander.

At runtime, this function simply returns the value as-is.

Examples

Example 1

type UserId = Brand<number, 'user'>;
const UserId: Brander<UserId> = identity;

Type Parameters

B extends AnyBrand

Parameters

underlying: BaseOf<B>

The value with a base type, to be casted

Returns

The same underlying value, but casted