Git Product home page Git Product logo

ecf's Introduction

ECF Query Database

Scrapes the ECF Grading Database for results
Returns a promise (that needs to be awaited or .then-ed) to user data. Comes with typescript support.

Dependencies

Installation

  • npm install ecf (includes its own index.d.ts file)
const ECF = require('ecf');

Usage

ECF.endpointName(queryParam, parse?)
  • Call any endpoint in this package by simply appending it to the package name as a method.
  • Each endpoint takes a query parameter, be it an ID, a search parameter, or a name. Use it as the first argument to the function.
  • Each endpoint takes a 'parse' Boolean as the second parameter. The library supports parsing the grabbed data from the ECF website into a nice, human-readable, format (which can be understood by trying each one). Set parse as true (default) to use this mode, otherwise set as false to just get the raw table rows.

Endpoints

  1. ECF.profile()

    • Gets a user's profile by ID
    • For a known user with a specific ECF ID, a user's data can be generated by:
    const ECF = require('ecf');
    
    (async () => {
    	console.log(await ECF.profile('170263E'));
    	//returns Gawain Jones' ECF profile as an object
    })();
  2. ECF.club()

    • Gets a user's profile using a club ID
    const ECF = require('ecf');
    
    (async () => {
    	console.log(await ECF.profile('1100'));
    	//returns users from the Oxford University Chess Club
    })();
  3. ECF.searchUsers()

    • Generates a list of possible users matching a search query.
    • List is in array form, with each element being a matching user.
    • Takes a query parameter of a string (name) or an 'AdvancedSearch' parameter - an object with possible fields 'firstName', 'lastName', 'middleName', 'id', 'isMember', 'sex', 'club'
    const ECF = require('ecf');
    
    (async () => {
    	console.log(await ECF.searchUsers('jones'));
    	//returns a list of users with the surname Jones
    	console.log(await ECF.searchUsers('jones, gawain'));
    	//returns a list of users with the surname Jones and first letter 'G'
    	console.log(await ECF.searchUsers({
    		firstName: 'Gawain',
    		lastName: 'Jones'
    	}));
    	//returns a list of users with the surname Jones and first letter 'G'
    })();
  4. ECF.searchClubs()

    • Generates a list of clubs across the country which have a name beginning with the specified query string
    • Takes a single string argument
    const ECF = require('ecf');
    
    (async () => {
    	console.log(await ECF.searchClubs('oxford'));
    	//returns a list of clubs with 'oxford' in their name
    })();
  5. ECF.search()

    • Generates a list of both users and clubs matching a query parameter
    • Takes a single string argument
    • Returns an object with 'Users' and 'Clubs' properties
    const ECF = require('ecf');
    
    (async () => {
    	console.log(await ECF.searchClubs('oxford'));
    })();

Examples

  • Find a specific user
     (async () => {
     	let result = await ecf.searchUsers(arguments[0], true);
     	let entry = rest.find(v => v.firstName === 'Gawain');
     	console.log(JSON.stringify(entry, null, 4));
     })();
     {
     	"id": "170263E",
     	"member": "GOLD",
     	"name": "Jones, Gawain CB",
     	"lastName": "Jones",
     	"firstName": "Gawain",
     	"middleName": "CB",
     	"club": "4NCL Guildford",
     	"standard": 275,
     	"previous": null,
     	"rapidplay": 277
     }

ecf's People

Contributors

thelazymd avatar

Stargazers

Vincent Simard avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.