README
slant-api
The first JS client for Slant.co API (unofficial)
Homepage | π Repository | π¦ NPM | π Documentation | π Issue Tracker
ππͺ Table of Content
- π§° Features
- πΆ Install
- π Usage
- π€ API
- β³ Changelog
- π Developing
- π€ Contributing
- π§ Contributors
- β Show your support
- π Community
- π¨βπ§ Maintainers
- π License
π§° Features
This library allows you to access these parts of Slant.co:
- tags
πΆ Install
npm install slant-api
Basic usage
import { Slant } from 'slant-api';
const slant = new Slant();
// Get all tags
const tags = await slant.tags();
β οΈ NOTE: Slant.co does not provide an official client for interacting with the website programatically. As such, we cannot guarantee the client will work 100% of the time.
We do our best. To check the integrity with Slant.co endpoints, see and run the integration tests in
test/integration
.
π€ API
TypeDoc documentation can be found here.
new Slant()
Initialize a new slant client instance.
slant.tags(): Tag[]
Get a list of all tags.
slant.tag(query): Tag
Get a single tag matching the query.
query
can be either a function, object or array, and is passed to Lodash.find as a predicate.
β³ Changelog
This projects follows semantic versioning. The changelog can be found here.
π Developing
If you want to contribute to the project or have forked it, this guide will get you up and going.
π€ Contributing
Contributions, issues and feature requests are welcome! Thank you β€οΈ
Feel free to dive in! See current issues, open an issue, or submit PRs.
How to report bugs, feature requests, and how to contribute and what conventions we use is all described in the contributing guide.
When contributing we follow the Contributor Covenant. See our Code of Conduct.
π§ Contributors
Contributions of any kind are welcome. Thanks goes to these wonderful people β€οΈ
Recent and Top Contributors
Generated using Hall of Fame.
All Contributors
Contribution type emoji legend
No additional contributors. Be the first one!
This project follows the all-contributors specification.
β Show your support
Give a βοΈ if this project helped you!
π Community
π¨βπ§ Maintainers
π€ Juro Oravec
- Twitter: @JuroOravec
- GitHub: @JuroOravec
- LinkedIn: @JuroOravec
- Sourcerer: @JuroOravec
π License
Copyright Β© 2020 Juro Oravec.
This project is MIT licensed.