Can we guarantee the uniqueness of a function parameter value during compilation?

Question

Can we guarantee the uniqueness of a function parameter value during compilation?

I have a set of static identifiers that I want to use to tag function calls. Instead of simply passing the identifiers as arguments, I would like to ensure that each identifier is unique and throws an error if the same identifier is passed more than once:

type Id = 'id-1' | 'id-2';

function foo(id : Id) {
  console.log(`my id: ${id}`);
}

foo('id-1');
foo('id-2');

Is there a way to create a magic type in TypeScript that enforces uniqueness for the identifiers passed to the function?

type MagicId = /* some magic type to achieve uniqueness */;

function foo(id : MagicId) {
  console.log(`my id: ${id}`);
}

foo('id-1');
foo('id-1'); // should throw a type error

typescript

Answer 1

Answer №1

If you want to achieve a certain behavior, you can use objects in the following way:

type Id = 'id-1' | 'id-2';

function _foo(id: Id) {
  console.log(`My id: ${id}`)
}

function foo<T extends Id>(id : T) {
  _foo(id);
  return {
    foo(id: Exclude<Id, T>) {
      _foo(id);
    }
  }
}

foo('id-1').foo('id-2'); // this is okay

foo('id-1').foo('id-1'); // this will result in an error

The outer foo function can accept both "id-1" and "id-2", while the inner can't due to type exclusion.

This approach works best for consecutive calls, as opposed to sporadic usage of the functions.

You can try out the code on the playground.

An enhanced version could be the following:

type Builder<T> = {
  foo<I extends T>(id: I): Builder<Exclude<T, I>>;
};

const builder = {
  foo<T extends Id>(id: T): Builder<Exclude<Id, T>> {
    console.log(`My id ${id}`);
    return this;
  },
};

builder.foo("id-1").foo("id-2");

This method recursively removes the types that have already been used:

builder
  .foo("id-1") // acceptable, allows usage of "id-2"
  .foo("id-2") // all values have been used, next one defaults to `never`
  .foo("id-1") // error, as "id-1" cannot be assigned to `never`

Check out the playground for more details.

Answer 2

If you want to achieve a certain behavior, you can use objects in the following way:

type Id = 'id-1' | 'id-2';

function _foo(id: Id) {
  console.log(`My id: ${id}`)
}

function foo<T extends Id>(id : T) {
  _foo(id);
  return {
    foo(id: Exclude<Id, T>) {
      _foo(id);
    }
  }
}

foo('id-1').foo('id-2'); // this is okay

foo('id-1').foo('id-1'); // this will result in an error

The outer foo function can accept both "id-1" and "id-2", while the inner can't due to type exclusion.

This approach works best for consecutive calls, as opposed to sporadic usage of the functions.

You can try out the code on the playground.

An enhanced version could be the following:

type Builder<T> = {
  foo<I extends T>(id: I): Builder<Exclude<T, I>>;
};

const builder = {
  foo<T extends Id>(id: T): Builder<Exclude<Id, T>> {
    console.log(`My id ${id}`);
    return this;
  },
};

builder.foo("id-1").foo("id-2");

This method recursively removes the types that have already been used:

builder
  .foo("id-1") // acceptable, allows usage of "id-2"
  .foo("id-2") // all values have been used, next one defaults to `never`
  .foo("id-1") // error, as "id-1" cannot be assigned to `never`

Check out the playground for more details.

Can we guarantee the uniqueness of a function parameter value during compilation?

Answer №1

Similar questions

Error in StoryBook addon-docs: "No props discovered for this particular component" when utilizing TypeScript

What is the process of changing a number to the double data type in JavaScript or TypeScript?

Locating a class variable using a string chosen from a DropDown menu

Adjusting the transparency of TabBadge in Ionic 2

Issues with Angular ng-bootstrap tabset component not functioning as expected

Tips for accessing the value from a subscription within a function in Ionic 3

Angular date selection with a range of plus two days, factoring in the exclusion of weekends

Error: Angular does not recognize session storage reference

Attempting to transfer information between components via a shared service

What is the best way to trigger an API call every 10 seconds in Angular 11 based on the status response?

Suddenly encountered issue when working with TypeScript Interfaces while integrating Quicktype 'allOf'

Retrieve the values of a dynamic JSON object and convert them into a comma-separated string using Typescript

What is the best way to specify types for a collection of objects that all inherit from a common class?

The issue of circular dependencies in TypeScript arises specifically within the Record type rather than in an ordinary object type

nodemon failing to automatically refresh files in typescript projects

Retrieving an array of objects from an API and attempting to store it using useState, but only receiving an empty

Modifying the menu with Angular 4 using the loggedInMethod

Having trouble accessing the useState hook in React context value with TypeScript

Definition of a class in Typescript when used as a property of an object

What steps should I take to resolve the 'invalid mime type' issue while transmitting an image as a binary string to Stability AI via Express?