Catalog npm
Back to packageRELEASE DETAILS

1.0.0

npm

42api-client

42client api wrapper

Published12 Nov 2021
Direct dependencies5
Transitive dependenciesNot calculated

README

Current package documentation

42api-client

About The Project

This project is a 42api client wrapper api. It will allow you to interface 42API easily in your future applications. The 42api client is written in nodeJS so will be compatible on backend side but also in front end side.

Built With

  • Nodejs
  • Axios
  • dotenv
  • eslint

(back to top)

Getting Started

To install the 42api-client in your project this is very easy, you can do it through NPM or download the library and put it on your project modules.

Installation

  1. Install the paquet npm install 42api-client
  2. Configure your env with the necessary variables as following
  CLIENT_ID=GET_YOURS_FROM_INTRA
  CLIENT_SECRET=GET_YOURS_FROM_INTRA
  ENDPOINT_API=https://api.intra.42.fr/v2
  SCOPES_API=profile public projects elearning tig forum
  SLEEP_TIME=330
  1. Invoke the module as following: const IntraClient = require('42api-client');
  2. TADAM :D

(back to top)

Usage

To give you an idea about how to use the library you can check the examples folder or the following example:

const payload = {
    'filter[campus_id]': 40,
    sort: 'begin_at',
  };
  const res = await ic.get('exams', {}, payload);
  console.log(res.data);

Roadmap

  • [] Use retry variable instead of sleep
  • [] Improve error handling
  • [] ???

If you have any suggestion, please open an issue on the offical repository.

(back to top)

License

Distributed under the MIT License.

Contact

Salim Aouas (@Signal) - signal@42madrid.com

(back to top)

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 5

Native requirements
5 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
axios
Environment
{
  "local_name": "axios",
  "alias": false,
  "peer_metadata": null
}
^0.24.0runtime
dotenv
Environment
{
  "local_name": "dotenv",
  "alias": false,
  "peer_metadata": null
}
^10.0.0runtime
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.2.0development
eslint-config-airbnb-base
Environment
{
  "local_name": "eslint-config-airbnb-base",
  "alias": false,
  "peer_metadata": null
}
^15.0.0development
eslint-plugin-import
Environment
{
  "local_name": "eslint-plugin-import",
  "alias": false,
  "peer_metadata": null
}
^2.25.3development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-U6qPbHt0JZKlrOX7iclqMQzJDZdzy8SrFvkIaDmfKaDpBI4ciDj3IpfeI/bwyXLpWR1DK49wvEytdtxBwa/+CQ==",
  "shasum": "8d4c82e4be234778dea43c26b830b93d0ab78dee",
  "tarball": "https://registry.npmjs.org/42api-client/-/42api-client-1.0.0.tgz",
  "fileCount": 4,
  "unpackedSize": 9643,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIGSf+OfhbIboc2EVrM9Nqzw3srL096TplE1CsgHl3u0YAiAYM34nZALGRgdWI4DS3XhFV2DQEZubKpdPDwQR9VB30g=="
    }
  ]
}

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:59 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:80a740d013bf55bfcd7b142a3565a3931270c1faa8ad1af1d6ffcdceeccb9ae0

Other collected versions

1.0.512 Nov1.0.412 Nov1.0.312 Nov1.0.212 Nov1.0.112 NovView all collected versions →