Bringing in additional types with the primary import using import/require

Question

Bringing in additional types with the primary import using import/require

I am currently creating a definition file for Airtable, and I have encountered an issue with the way they export their classes. They only provide one class like this:

...

module.exports = Airtable;

As a result, my airtable.d.ts file looks something like this:

declare module "airtable" {
    export type CustomType = { ... };

    export class Airtable {
        ...
    }

    export = Airtable;
}

When I try to import the Airtable class, everything works smoothly:

import Airtable = require("airtable");
...
new Airtable(...)

However, I am struggling to figure out how to import the CustomType:

let a: Airtable.CustomType;

This line results in the following error:

'Airtable' is only referring to a type and cannot be used as a namespace here.

And when I try this approach:

import { CustomType } from "airtable";

I get these errors:

The module "airtable" does not have an exported member called 'CustomType'.
The module "airtable" resolves to a non-module entity and cannot be imported using this method.

Do you have any suggestions on how I can import other exported types while still utilizing export = and import/require?
Thank you.

typescript types airtable

Answer 1

Answer №1

The answer depends on how you plan to utilize the types. If they are for your own project, create a file named `<whatever>.d.ts` that declares a module called "airtable". Within this file, you need to export something. Since you are exporting a class, use the syntax export = X instead of export X as you are modifying the entire export object rather than adding a property to it (more details on this shortly). Regarding types, outside the module in your .d.ts file, you can also declare a type that will be globally accessible. Alternatively, you can place your type inside a module if you prefer. This is purely TypeScript and does not require any JavaScript code behind it. You can import/export it as usual:

// my.d.ts

declare module 'airtable' {
  class Airtable {
    constructor(opts?: MyType)
  }
  export = Airtable
}

declare type MyType = string | number

declare module 'AirtableTypes' {
  export type MyString = string
  export type MyNumber = number
}

Usage example:

// index.ts
import Airtable from 'airtable'
import AirtableTypes from 'AirtableTypes'

const a = new Airtable('a')

const n: MyType = 3

const s: AirtableTypes.MyString = '3'

If you wish to contribute types to DefinitelyTyped (which would be appreciated!), follow the guide outlined here to create the declaration file.

You rightly observed that Airtable exports a single class, which may not integrate well with TS. Further discussion can be found here. Regardless, the provided guide will direct you to module-class.d.ts, enabling you to define an exported class along with accompanying types. In the example above, this format could not be used since it is only applicable when definition files are located in the module root or @types/<module>.

/*~ This declaration ensures that the class constructor function
 *~ is the exported object from the file
 */
export = Airtable

/*~ Define your module's methods and properties within this class */
declare class Airtable {
  constructor(opts?: Airtable.AirtableMethodOptions)
}

/*~ If you want to expose types from your module, include them here.
 */
declare namespace Airtable {
  export interface AirtableMethodOptions {
    endpointUrl: string
  }
}

Answer 2

The answer depends on how you plan to utilize the types. If they are for your own project, create a file named `<whatever>.d.ts` that declares a module called "airtable". Within this file, you need to export something. Since you are exporting a class, use the syntax export = X instead of export X as you are modifying the entire export object rather than adding a property to it (more details on this shortly). Regarding types, outside the module in your .d.ts file, you can also declare a type that will be globally accessible. Alternatively, you can place your type inside a module if you prefer. This is purely TypeScript and does not require any JavaScript code behind it. You can import/export it as usual:

// my.d.ts

declare module 'airtable' {
  class Airtable {
    constructor(opts?: MyType)
  }
  export = Airtable
}

declare type MyType = string | number

declare module 'AirtableTypes' {
  export type MyString = string
  export type MyNumber = number
}

Usage example:

// index.ts
import Airtable from 'airtable'
import AirtableTypes from 'AirtableTypes'

const a = new Airtable('a')

const n: MyType = 3

const s: AirtableTypes.MyString = '3'

If you wish to contribute types to DefinitelyTyped (which would be appreciated!), follow the guide outlined here to create the declaration file.

You rightly observed that Airtable exports a single class, which may not integrate well with TS. Further discussion can be found here. Regardless, the provided guide will direct you to module-class.d.ts, enabling you to define an exported class along with accompanying types. In the example above, this format could not be used since it is only applicable when definition files are located in the module root or @types/<module>.

/*~ This declaration ensures that the class constructor function
 *~ is the exported object from the file
 */
export = Airtable

/*~ Define your module's methods and properties within this class */
declare class Airtable {
  constructor(opts?: Airtable.AirtableMethodOptions)
}

/*~ If you want to expose types from your module, include them here.
 */
declare namespace Airtable {
  export interface AirtableMethodOptions {
    endpointUrl: string
  }
}

Bringing in additional types with the primary import using import/require

Answer №1

Similar questions

Can you provide guidance on implementing Material-UI's `withStyles` decorator in a practical scenario?

React type error: The argument 'profile' cannot be assigned to the parameter of type 'ComponentType<never>'

Leveraging an AngularJS service within Angular framework

Encountering incorrect month while utilizing the new Date() object

Typescript compiler still processing lib files despite setting 'skipLibCheck' to true

The variable 'module' is required to be of type 'any', but it is currently identified as type 'NodeModule'

How can you make sure that VS Code always utilizes relative paths for auto imports in TypeScript?

Spacing Problem with Title Tooltips

Is it possible for object destructuring in Javascript to include dynamic non-rest keys using ...rest?

merging JavaScript objects with complex conditions

What is the designation of an iterator?

Retrieve information from Firebase outside of the .on() method

Setting default values for multiple selections can be accomplished by following these steps

What is the reason behind TypeScript failing to provide type safety in a generic higher order component which introduces extra properties into React components?

I'm encountering an error when trying to use makeStyles

Ensure that at least one of two props is mandatory in a functional component while using typescript

What is the best method for inserting content into a custom element as input for the component?

Utilizing sourcemaps in ionic for seamless linking

Tips for designating the category of factory objects

After inputting new values, the table is not allowing me to update it