Giter VIP home page Giter VIP logo

ts-pathof's Introduction

NPM Version

ts-pathof

Typesafe path to variable
Implementation of microsoft/TypeScript#20423

There is limitations for 2 level deep with type hacks, so no infinit tuples

Install & Use

npm i ts-pathof --save-exact
import { pathOf } from 'ts-pathof';

const c = { z: { y: { bb: 123 }}};
const path = pathOf(c, 'z', 'y', 'bb');

// path now is typeof [ 'z', 'y', 'bb' ]
const path2 = pathOf(c, 'z', 'y', 'gg'); // error, because no 'gg' field in c.z.y

Maximum 10 levels deep limitation on pathOf

Path as tuple

import { hasPath } from 'ts-pathof';

const c = { z: { y: { bb: 123 }}};
const path = hasPath(c, [ 'z', 'y', 'bb' ]); // ok
const path2 = hasPath(c, [ 'z', 'y', 'gg' ]); // false & compilation error

Maximum 20 levels deep limitation on hasPath

Type only assertion

Use pathOfN (where N is deep), to pick tuple-type path to field
Maximum 10 levels deep

Eg:

let path: pathOf3<typeof c, 'z', 'y', 'bb'>;
path = pathOf(c, 'z', 'y', 'bb');

Use other type-only variant (with 20 levels limitation on deep), PathOf:

const o = {x: { y: 10 }};

type xy = PathOf<typeof o, ['x', 'y']>; // ok

type xyz = PathOf<typeof o, ['x', 'y', 'z']>; // error

PS

Check out typedpark, and Variadic Kinds thread for more info on advenced tuple utils.
Eg picking head or tail of tuple, reverse or join.

type composed = Compose<[boolean, string], [number]>;

composed -> [boolean, string, number]

Also checkout tsargs, utility types for arguments.

ts-pathof's People

Contributors

morglod avatar

Watchers

 avatar  avatar

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.