Navy Penguin Mariachi

    epfl-people-api

    6.0.1 • Public • Published

    EPFL People API Client

    EPFL People API Client.

    Build Status Coverage Status Apache License 2.0 NPM Version


    Install

    npm i epfl-people-api --save

    Usage

    const epflPeopleApi = require('epfl-people-api');
    
    const person = await epflPeopleApi.findBySciper(128871, 'en');
    console.log(person.firstname);                  // => 'Lindo'
    console.log(person.name);                       // => 'Duratti'
    console.log(person.accreds[0].officeList[0]);   // => 'MA A0 393'
    console.log(person.accreds[0].position);        // => 'Computer Scientist'
    
    
    const user = await epflPeopleApi.findByEmail('lindo.duratti@epfl.ch', 'en');
    console.log(user.firstname);                 //=> 'Lindo'
    console.log(user.sciper);                    //=> '128871'
    console.log(user.accreds[0].phoneList[0]);   //=> '+41216934553'
    console.log(user.accreds[0].acronym);        //=> 'ISAS-FSD'
    
    
    const list = await epflPeopleApi.find('Oryshchuk', 'en');
    console.log(list[0].firstname);   //=> 'Anastasiia'
    
    
    const photo = await epflPeopleApi.hasPhoto(128871);
    console.log(photo);   //=> false
    
    
    const url = await epflPeopleApi.getPhotoUrl(278890);
    console.log(url);   //=> https://people.epfl.ch/private/common/photos/links/278890.jpg

    API

    .findBySciper(sciper, locale)

    Type: function

    Returns a Promise with a person as parameter.

    sciper

    Type: number

    6-digit unique EPFL identification number.

    locale

    Type: string
    Default: en

    Supported locales are English (en) and French (fr).

    .findByEmail(email, locale)

    Type: function

    Returns a Promise with a person as parameter.

    email

    Type: string

    A valid email address.

    locale

    Type: string
    Default: en

    Supported locales are English (en) and French (fr).

    .find(q, locale)

    Type: function

    Returns a Promise with a list of person as parameter.

    q

    Type: string

    The term to look for.

    locale

    Type: string
    Default: en

    Supported locales are English (en) and French (fr).

    .hasPhoto(sciper)

    Type: function

    Returns a Promise with a boolean as parameter.

    sciper

    Type: number

    6-digit unique EPFL identification number.

    .getPhotoUrl(sciper)

    Type: function

    Returns a Promise with a string as parameter.

    sciper

    Type: number

    6-digit unique EPFL identification number.

    See also

    Contributing

    Contributions are always welcome.

    See Contributing.

    Developer

    License

    Apache License 2.0

    Original work (c) ECOLE POLYTECHNIQUE FEDERALE DE LAUSANNE, Switzerland, VPSI, 2017-2018.
    Modified work (c) William Belle, 2018-2022.

    See the LICENSE file for more details.

    Install

    npm i epfl-people-api

    DownloadsWeekly Downloads

    5

    Version

    6.0.1

    License

    Apache-2.0

    Unpacked Size

    18.2 kB

    Total Files

    4

    Last publish

    Collaborators

    • williambelle