Code Monkey home page Code Monkey logo

Comments (5)

tim-smart avatar tim-smart commented on July 19, 2024

You should not use Record<string, never> in a tagged enum declaration, as that is not equivalent to {} (an object with no keys).

from effect.

johnnywalker avatar johnnywalker commented on July 19, 2024

The ESLint rules enabled by plugin:@typescript-eslint/recommended includes the ban-types rule, and this specifically bans {}. I'm no expert in TypeScript internals, so I'll defer to existing discussions.

This comment explains their logic behind banning {}: typescript-eslint/typescript-eslint#2063 (comment)

There is additional discussion here: microsoft/TypeScript#47486.

If Record<string, never> is indeed correct, then we can certainly ignore the rule when using taggedEnum.

from effect.

tim-smart avatar tim-smart commented on July 19, 2024

If you have to use Record, then the correct type would be Record<never, never>.

from effect.

johnnywalker avatar johnnywalker commented on July 19, 2024

I tested that as well, and it seems Record<never, never> is equivalent to {}. It allows any non-nullish value.

// allows any key (does not enforce empty object)
const objectTest: Record<never, never> = { x: 1 }
// allows non-object values
const stringTest: Record<never, never> = "hello"
const boolTest: Record<never, never> = true
const numberTest: Record<never, never> = 1
const arrayTest: Record<never, never> = [1, 2, 3]
// this fails - `null` is not allowed
const fails: Record<never, never> = null

from effect.

mikearnaldi avatar mikearnaldi commented on July 19, 2024

While general usage of the type {} may be discouraged in this case it is really not an issue, at the end the type you'll work with is { _tag: yourTag } so this is rather an issue with a too strict eslint rule, as Tim suggested if you want to keep such rule you can use Record<never, never>

from effect.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.