Back to Definitelytyped

Type definitions for square-connect

types/square-connect/README.md

0.1.4501.6 KB
Original Source

Type definitions for square-connect

This is an unofficial package of type definitions for square-connect. Initially, it was generated by swagger-codegen but currently it requires to be updated manually and takes a lot of time. Hence, you may encounter typings update delays in contrast to the official library.

To keep me motivated you can buy me a beer 😉

Installation

npm i @types/square-connect

in @types/square-[email protected] all API-v1 related typings were removed, if you need them - install @types/square-[email protected]

@todo

  • Declare methods definition for missing classes (ex: export class SomeApi {})
  • Change anys in methods definitions (ex: doSomething(...args: Array<any>)) regarding the docs

Contribution

If you are facing some issues or you have an idea how to improve typings - feel free to contribute or open an issue.

  • Clone the DefinitelyTyped project and configure upstream (git remote add upstream [email protected]:DefinitelyTyped/DefinitelyTyped.git)
    • or ony update the repo if you already have it (git fetch upstream && git reset --hard upstream/master)
  • Add your changes and commit them (in case of error in api.json too, let the Square team know about it)
  • Test your changes:
    • npm run lint square-connect
    • npm run test square-connect