@jpmonette/req

@jpmonette/req

@jpmonette/req - a JavaScript client library for accessing the Registre des entreprises du Québec.

Getting Started

Installation

$ yarn add @jpmonette/req

Usage

Import

Using Node

import REQ from "req";

Using Deno

import REQ from "https://deno.land/x/req@v1.0.0/src/index.ts";

Search a NEQ

const client = new REQ();
const company = await client.getNEQ("1143920115");
console.log(company.SectionInformationsGenerales.SousSecIdentification.NomEntreprise);
// Output: BOMBARDIER INC.

Search the registry

const client = new REQ();
const companies = await client.search({ keywords: "mrc" });

companies.ListeEntreprises.map((company) => {
  console.log(`(${company.NumeroDossier}) ${company.Nom}`);
});
// Output:
// (1165737934) M.R.C.
// (2260227451) M.R.C.
// (1161426722) MRC CARE
// (1142443804) MRC GROUP
// ...

Roadmap

This library is being initially developed for one of my internal project, so API methods will likely be implemented in the order that they are needed by my project. Eventually, I would like to cover the entire API, so contributions are of course always welcome. The calling pattern is pretty well established, so adding new methods is relatively straightforward.

License

This library is distributed under the MIT license found in the LICENSE file.