Expanding @types: Remove a field from an interface and specify a type for a field in the interface

Question

Expanding @types: Remove a field from an interface and specify a type for a field in the interface

I have a JavaScript library with types installed from npm/@types.

There are two specific fixes I need to make to the @types package that only apply to my application, so merging them into DefinitelyTyped is not an option.

Here's what I need to do:

Remove one field from an interface. For example:

// Before changes:
interface A {
        a?: string;
        b?: string;
        c?: string;
}

// After changes:
interface A {
        a?: string;
        c?: string;
}

Add more types to a field in an interface. For example:

// Before changes:
interface B {
        a?: C;
}

// After changes:
interface B {
        a?: C | D;
}

I still want to download the main @types definitions from an external repository. What is the best way to achieve this?

typescript typescript-typings definitelytyped typescript-types

Answer 1

Answer №1

To resolve this issue, one can utilize the method outlined below.

import { A as AImplementation, B as BImplementation, C, D } from './contracts.ts';

// Excludes 'b' property from interface A.
interface A extends Omit<AImplementation, 'b'> { }

interface B extends BImplementation {
  a?: C | D;
}

Answer 2

To resolve this issue, one can utilize the method outlined below.

import { A as AImplementation, B as BImplementation, C, D } from './contracts.ts';

// Excludes 'b' property from interface A.
interface A extends Omit<AImplementation, 'b'> { }

interface B extends BImplementation {
  a?: C | D;
}

Answer 3

Answer №2

In TypeScript, it is not possible to directly override type declarations of properties within existing interfaces. However, a workaround for this is to extend the type interfaces by redefining the property types:

interface updatedA extends A {
  b?: never;
}

interface updatedB extends B {
  a?: C | D;
}

Answer 4

In TypeScript, it is not possible to directly override type declarations of properties within existing interfaces. However, a workaround for this is to extend the type interfaces by redefining the property types:

interface updatedA extends A {
  b?: never;
}

interface updatedB extends B {
  a?: C | D;
}

Expanding @types: Remove a field from an interface and specify a type for a field in the interface

Answer №1

Answer №2

Similar questions

Is there a different option similar to forkJoin for handling incomplete observables?

Encountering TypeScript Observable Error When Sending Multiple API Requests (Angular, TypeScript, RxJS)

Switch from using getElementById to useRef in React components

An issue has occurred while attempting to differentiate '[object Object]'. Please note that only arrays and iterable objects are permitted

Angular recognizing string-array type as a string input is not correct

Ionic - What is the correct way to import ViewController? - Uncaught (in promise): Error: ViewController provider not found

Working with a function in the stylesheet of TypeScript in React Native allows for dynamic styling

In order to determine if components linked from anchor elements are visible on the screen in Next.js, a thorough examination of the components

I am looking to store a collection of objects in Firebase using a single request, and I want Firebase to generate a unique key for each object without using array

The specified type argument is not compatible with the ObservableInput<any> type

Can someone explain how to implement document.querySelector in TypeScript within the Angular framework?

Is it possible to set TypeScript compiler options that aren't listed in the tsconfig.json file

Looking for help with setting up Nodemailer and installing it via NPM

How can one effectively utilize TypeScript with native JavaScript methods and calls?

Implementing a delay for triggering an event in Angular based on certain conditions

An error is encountered with the getToken function in the Edge Runtime when using dynamic code evaluation methods such as 'eval', 'new Function', or 'WebAssembly.compile'

What is the best way to trigger a mat-menu to open with just one click, while also automatically closing any other open menus at

Using Array.push within a promise chain can produce unexpected results

The function signature '(newValue: DateRange<dateFns>) => void' does not match the expected type '(date: DateRange<unknown>, keyboardInputValue?: string | undefined) => void' as per TypeScript rules

Strategies for handling asynchronous requests and effectively presenting the retrieved data