What is the proper way to define a new property for an object within an npm package?

Question

What is the proper way to define a new property for an object within an npm package?

Snippet:

import * as request from 'superagent';

request
    .get('https://***.execute-api.eu-west-1.amazonaws.com/dev/')
    .proxy(this.options.proxy)

Error in TypeScript:

Property 'proxy' is not found on type 'SuperAgentRequest'

Type annotations for the 'request' module:

(alias) namespace request
(alias) const request: request.SuperAgentStatic
import request

My attempt at creating type definitions (which did not resolve the TypeScript error):

declare module superagent {
    interface SuperAgentRequest {
        proxy: any;
    }
}

What mistake could be present in my declaration file?

typescript

Answer 1

Answer №1

One important thing to remember is to always include double quotes around the word superagent when declaring the module.

If you are starting from scratch without any types to enhance, you can create a separate .d.ts file (e.g. globals.d.ts) and add the following code:

declare module "superagent" {
  interface SuperAgentRequest {
    proxy: any;
  }

  export function get(s: string): SuperAgentRequest;
}

After creating this declaration file, you can then import the module in your TypeScript file like this:

import * as request from "superagent";

request
  // The get method returns a request.SuperAgentRequest object
  .get("https://***.execute-api.eu-west-1.amazonaws.com/dev/")
  .proxy(this.options.proxy);

Answer 2

One important thing to remember is to always include double quotes around the word superagent when declaring the module.

If you are starting from scratch without any types to enhance, you can create a separate .d.ts file (e.g. globals.d.ts) and add the following code:

declare module "superagent" {
  interface SuperAgentRequest {
    proxy: any;
  }

  export function get(s: string): SuperAgentRequest;
}

After creating this declaration file, you can then import the module in your TypeScript file like this:

import * as request from "superagent";

request
  // The get method returns a request.SuperAgentRequest object
  .get("https://***.execute-api.eu-west-1.amazonaws.com/dev/")
  .proxy(this.options.proxy);

What is the proper way to define a new property for an object within an npm package?

Answer №1

Similar questions

typescript: the modules with relational paths could not be located

Encountering issues with utilizing global variables in Ionic 3

Tips for effectively utilizing Mongoose models within Next.js

Using `it` with accessing class members

Issue with type narrowing and `Extract` helper unexpectedly causing type error in a generic type interaction

Formik QR code reader button that triggers its own submission

Absence of property persists despite the use of null coalescing and optional chaining

What Mac OSX command can you use in Typescript to input the quote character for multiline text?

How to pass an array as parameters in an Angular HTTP GET request to an API

Create the HTTP POST request body using an object in readiness for submission

What is the necessity behind keeping makeStyles and createStyles separate in Material UI with TypeScript?

Updating the status of the checkbox on a specific row using Typescript in AngularJS

TypeScript Definitions for Material-UI version 15

What is the most effective method for delivering a Promise after an asynchronous request?

Ways to initiate a fresh API request while utilizing httpClient and shareReplay

Pinia is having trouble importing the named export 'computed' from a non-ECMAScript module. Only the default export is accessible in this case

Angular 2 feature that allows for a single list value to be toggled with the

Is there a way to deactivate multiple time periods in the MUI Time Picker?

Here is a way to return a 400 response in `express.js` when the JSON request body is invalid

What steps can be taken to prevent a tab click from causing issues?