gigs
A jobs/careers/openings/positions aggregator
Install
Ensure you have Node.js version 10+ installed. Then run the following:
npm install --save gigs
Usage
const gigs = ; const foo = ; ;
API
gigs(adapters)
Returns a new Processor
instance set up with adapters
.
A Processor
has only a process()
method which runs its adapters and returns
a promise
with the results.
adapters
Type: array
An array of adapters.
gigs.create(data)
Returns a gigs
object.
Use this method in your adapter to create a gigs
object.
data
Type: object
A plain object used to populate the gigs
object.
Further notes
Adapter
An adapter is a function
that returns an array
of gigs
objects wrapped in a promise
.
It retrieves data, transforms it, and returns it.
Each adapter is an npm module with a name in the format of gigs-adapter-<adapter-name>
,
e.g. gigs-adapter-stackoverflow-jobs
.
Gigs
A gigs
object is a plain object with these members:
source
Type: string
Name of the adapter without the gigs-adapter-
prefix, e.g. stackoverflow-jobs
.
source_url
Type: string
URL of the site where the data comes from, e.g. http://awesome-job-board.foo
title
Type: string
Name of the position, e.g. Senior Vice President Jr.
description
Type: string
Description of the position, e.g. We're looking for fearless Taco Chef here at "Only Vegan Food, Inc."
url
Type: string
URL where you can find more information about the position, e.g. http://only-vegan-food.foo/careers/taco-chef
company_name
Type: string
Name of the company offering the position, e.g. Only Vegan Food, Inc.
location
Type: string
Location of the position. null
for remote positions, e.g. San Francisco, CA, US
full_time
Type: boolean
Whether the position is full-time or not.
remote
Type: boolean
Whether the position is remote (or allows remote).
published_at
Type: string
Publication date of the position in (UTC) YYYY-MM-DD
format, e.g. 2016-12-16
Related
- gigs-adapter-authenticjobs - A gigs adapter for Authentic Jobs
- gigs-adapter-codepen-jobs - A gigs adapter for CodePen's job board
- gigs-adapter-crunchboard - A gigs adapter for CrunchBoard
- gigs-adapter-dribbble-jobs - A gigs adapter for Dribbble's job board
- gigs-adapter-github-jobs - A gigs adapter for GitHub's job board
- gigs-adapter-landingjobs - A gigs adapter for Landing.jobs
- gigs-adapter-nofluffjobs - A gigs adapter for No Fluff Jobs
- gigs-adapter-stackoverflow-jobs - A gigs adapter for Stack Overflow's job board
License
MIT © Alejandro Beltrán