Natural Pacifist Manatees

    typyts
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.5 • Public • Published

    typyts

    typyts is a library to safely access nested object.

    t({foo: { bar: 10 } }, "foo.bar").isNumber // true

    Usage

    const v = t(null, "foo");
    expect(v.safeObject).to.eql({});
    
    const msg = { a: 2 };
    const v = t({"foo": msg}, "foo");
    expect(v.safeObject).to.eql(msg);
    
    const msg = "Hello World";
    const v = t({a: { b: msg }}, "a.b");
    expect(v.safeString).to.equal(msg);
    
    const msg = "Hello World";
    const v = t({a: { b: msg }}, "a.c");
    expect(v.safeString).to.equal("");
    
    const msg = 1337;
    const v = t({"foo": msg}, "foo");
    expect(v.safeNumber).to.equal(msg);
    
    const msg = 1337;
    const v = t({a: { b: msg }}, "a.b");
    expect(v.safeNumber).to.equal(msg);
    
    const msg = [1, 2];
    const v = t({a: { b: msg }}, "a.b");
    expect(v.safeArray).to.eql(msg);

    Interface

    export declare class Typd {
        input: any;
        path: string[];
        data: any;
        constructor(input: any, path: string[]);
        getValue<T>(nullValue: T): T;
        get safeString(): string;
        get safeNumber(): number;
        get safeBoolean(): boolean;
        get safeArray(): any[];
        get safeObject(): {};
        safeGenericObject<T = any>(): T;
        get isString(): boolean;
        get isNumber(): boolean;
        get isBoolean(): boolean;
        get isArray(): boolean;
        get isObject(): boolean;
        get isNull(): boolean;
        get isUndefined(): boolean;
    }
    
    export declare function t(input: any, path: string | string[]): Typd;

    Misc

    Inspired by typy.

    Install

    npm i typyts

    DownloadsWeekly Downloads

    22

    Version

    1.0.5

    License

    LGPL 3.0

    Unpacked Size

    66.3 kB

    Total Files

    25

    Last publish

    Collaborators

    • burner_rs