https://github.com/selfmadesystem/you.js
You.com API Library
https://github.com/selfmadesystem/you.js
Last synced: 5 days ago
JSON representation
You.com API Library
- Host: GitHub
- URL: https://github.com/selfmadesystem/you.js
- Owner: SelfMadeSystem
- License: apache-2.0
- Created: 2023-11-20T20:10:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T20:22:35.000Z (over 2 years ago)
- Last Synced: 2025-03-04T17:51:46.393Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 626 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
You.JS
An unofficial JavaScript library for You.com.
About •
Install •
How To Use •
License
## About
Welcome to the the You.JS Library!
This library allows developers to easily access and utilize all of the functionality of the You.com platform through a simple and intuitive JavaScript API. With the library, developers can access a variety of You.com apps and services, including but not limited to:
* The search engine
To get started with You.JS, read install and then how to use.
We hope you enjoy using You.JS!
> adapted from [YouDotCom](https://github.com/YouAPI/YouDotCom)'s README.md
## Install
To install the You.JS library, simply run the following command in your terminal:
```bash
npm install youdotjs # for npm
yarn add youdotjs # for yarn
pnpm add youdotjs # for pnpm
bun install youdotjs # for bun
```
> Note: You.JS is named `youdotjs` on npm because `youjs` is already taken and `you.js` is too similar.
> Note: It should work in the browser, but it's not tested.
## How To Use
### Search
To search You.com, you can use the `search` function. It takes in a query and returns a `Promise` that resolves to a `SearchResult` object.
```javascript
const you = require('youdotjs');
const API_TOKEN = 'Put your API token here';
you.search('Hello world!', API_TOKEN).then((result) => {
console.log(result);
});
```
### YouChat
Currently not implemented.
## Discord
You.com has an official Discord server! Join it [here](https://you.club). Don't expect to get any support for this library there, though.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details