Enclose the type definition for a function from a third-party library

Question

Enclose the type definition for a function from a third-party library

I prefer to utilize Typescript for ensuring immutability in my code. Unfortunately, many libraries do not type their exported function parameters as Readonly or DeepReadonly, even if they are not meant to be mutated. This commonly causes issues because a ReadonlyArray is not compatible with an Array.
One way to address this issue is by redefining the function using module augmentation, which is explained in this Stack Overflow post: here. However, I am curious about how we can wrap an existing type definition so that we maintain the current definition but define all parameters as DeepReadonly.

typescript typescript-typings typescript-generics

Answer 1

Answer №1

I suggest utilizing this generic code snippet:

export type DeepReadonlyObject<A> = { readonly [K in keyof A]: DeepReadonlyObject<A[K]> };

This will transform all attributes to readonly and recursively set all values as DeepReadonlyObject values.

Playground

-------------Edited---------------

If you need to override imported types, you can do so using the declare module "Lib" { syntax. However, it's not possible to use iterations in module definition, so each key needs to be declared individually like this:

module "Lib" { 
    export const value = { key: 42 };
    export const value1 = { key: 42 };
}

declare module "Lib" {
    export type value = DeepReadonlyObject<typeof Lib.value>;
}

Unfortunately, each key must be placed separately in the declared module.

Answer 2

I suggest utilizing this generic code snippet:

export type DeepReadonlyObject<A> = { readonly [K in keyof A]: DeepReadonlyObject<A[K]> };

This will transform all attributes to readonly and recursively set all values as DeepReadonlyObject values.

Playground

-------------Edited---------------

If you need to override imported types, you can do so using the declare module "Lib" { syntax. However, it's not possible to use iterations in module definition, so each key needs to be declared individually like this:

module "Lib" { 
    export const value = { key: 42 };
    export const value1 = { key: 42 };
}

declare module "Lib" {
    export type value = DeepReadonlyObject<typeof Lib.value>;
}

Unfortunately, each key must be placed separately in the declared module.

Enclose the type definition for a function from a third-party library

Answer №1

Similar questions

Issue with esbuild not executing within docker compose configuration

Adjust the size of the plane in Three.js to match the entire view

Is it feasible to alter the file name while utilizing express-fileUpload library?

Technique in CSS/SASS to repair a div

Pause before sending each request

What steps can be taken to resolve the error "Incompatible types: TodoItem undefined cannot be assigned to type TodoItem"?

Transforming a non-specific type into a container permits precarious assignments

The art of linking Observables on the fly in rxjs and angular

Error message in Angular states that it is not possible to bind to 'formGroup' because it is not recognized as a property of 'form' within Angular

Error encountered when attempting to retrieve token from firebase for messaging

Angular 6 component experiencing issues with animation functionality

Mistakes that occur while trying to expand a base class to implement CRUD functionality

Tips for preventing <v-layouts> from impacting one another

Exploring the Differences Between ionViewWillEnter and ionViewDidEnter

Is there a way for me to deduce types dynamically?

Kendo's comboBox for local virtualization

Stop unwanted clicking on inactive buttons in Angular

What could be causing routerLink to malfunction despite correct configuration?

Establish a connection with MongoDB and make changes to the data

Angular Material Datepicker: Changing the input field format when the field value is updated