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

• Stack Overflow
• Quora

👨‍🔧 Maintainers

👤 Juro Oravec

• Twitter: @JuroOravec
• GitHub: @JuroOravec
• LinkedIn: @JuroOravec
• Sourcerer: @JuroOravec

📝 License

Copyright © 2020 Juro Oravec.

This project is MIT licensed.