Have ideas to improve npm?Join in the discussion! »

    cestlagreve-strikes

    1.0.3 • Public • Published

    cestlagreve-strikes

    Calendar scraper for cestlagreve.fr, a french website providing all strike dates in France.

    Getting started

    Prerequisites

    • NodeJS
    • NPM
    • Yarn

    Install

    From npm

    yarn add cestlagreve-strikes

    or

    npm i cestlagreve-strikes --save

    Use

    const cestlagreve = require('cestlagreve-strikes');

    Get parameters

    cestlagreve.getParams().then(console.log)

    Returns this.

    Get strikes

    cestlagreve.getStrikes({
        month,
        year,
        regionId,
        departmentId,
        departmentCode,
        sectorId
    }).then(console.log)

    Params :

    • month : (integer, optional) MM format
      Defaults to current month
    • year : (integer, optional) YYYY format
      Defaults to current year
    • regionId : (integer, optional) As returned by getParams()
    • departmentId : (integer, optional) As returned by getParams()
    • departmentCode : (string, optional) French department code
    • sectorId : (string, optional) As returned by getParams()

    Note : defining more than one of the last 3 parameters would be pointless.

    Returns an array (days of month) of arrays (strikes of day) with the following properties :

    • name : (string) Event name in french
    • link : (string) URL to related blog article in french

    Get iCal

    cestlagreve.getIcal(options).then(console.log)

    Params : same as getStrikes()

    Note : This function will fetch all available future events (including next months).

    Returns this

    Changelog

    • 1.0.0 (2020-03-03) • Initial release
    • 1.0.1 (2020-03-04) • Add filter by sector ID
    • 1.0.2 (2020-03-04)
      • Fix current month beginning with last days of previous month
      • Add iCal generator
    • 1.0.3 (2020-03-04) • Fix iCal date & description tags

    Keywords

    none

    Install

    npm i cestlagreve-strikes

    DownloadsWeekly Downloads

    1

    Version

    1.0.3

    License

    WTFPL

    Unpacked Size

    49.8 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar