README.md

sans-null

TypeScript library that deep removes null values from objects, arrays, and nested structures, replacing them with undefined.

Installation

You can install sans-null via npm:

npm i sans-null

Usage

Import sansNull from the library and use it to remove null values from your data structures.

import { sansNull } from 'sans-null';

const data = {
    a: null,
    b: [1, null, 3],
    c: {
        d: null,
        e: 'text',
        f: {
            g: null,
        },
    },
};

const result = sansNull(data);

// result
// {
//     a: undefined,
//     b: [1, undefined, 3],
//     c: {
//         d: undefined,
//         e: 'text',
//         f: {
//             g: undefined,
//         },
//     },
// }

// typeof result
// {
//     a: undefined;
//     b: (number | undefined)[];
//     c: {
//         d: undefined;
//         e: string;
//         f: {
//             g: undefined;
//         };
//     };
// }

API

sansNull<T>(value: T): SansNull<T>

Transforms the input value by replacing all null values with undefined.

Parameters

• value: The input value which can be of any type.

Returns

• A new value with the same structure as the input, but with all null values replaced by undefined.

TypeScript

The SansNull type is available. Additionally, the sansNull function itself can accept a type to ensure type safety.

import { sansNull, SansNull } from 'sans-null';

type DataType = {
    a: number;
    b: string | null;
    c: {
        d?: string | null;
        e: (number | null)[];
    };
};

// Using SansNull as a generic type
type DataTypeSansNull = SansNull<DataType>;

// DataTypeSansNull
// {
//     a: number;
//     b: string | undefined;
//     c: {
//         d?: string | undefined;
//         e: (number | undefined)[];
//     };
// }

const data: DataType = {
    a: 1,
    b: null,
    c: {
        d: null,
        e: [1, null, 3]
    }
};

// Using sansNull with a type
// Note this example is redundant as the correct type is inferred.
const result = sansNull<DataType>(data);

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.