Skip to content

Create type definitions #137

Description

@ciatph

Is your feature request related to a problem? Please describe.

  • Need for better support and tooling for TypeScript users by defining the expected types (shape) definitions of the (CommonJS) class and function input parameters and output.

Describe the solution you'd like

  • Create .d.ts files containing function, class, and global type definitions used by the ph-municipalities classes and functions.
  • Include the .d.ts files in the npm package.

Describe alternatives you've considered

  • Writing JSDoc annotations about the functions and their input/output function parameters
  • Sometimes, these are verbose and do not capture the actual shape and type of the input/output function parameters

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions