Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sapphdevelopment/myfacts
A simple npm package to get a random fact
https://github.com/sapphdevelopment/myfacts
Last synced: 30 days ago
JSON representation
A simple npm package to get a random fact
- Host: GitHub
- URL: https://github.com/sapphdevelopment/myfacts
- Owner: SapphDevelopment
- License: mit
- Created: 2023-04-17T18:19:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-16T14:37:00.000Z (over 1 year ago)
- Last Synced: 2024-11-06T16:49:40.052Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/myfacts
- Size: 43.9 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# myFacts NPM Package
This is an NPM package that provides random facts in various categories. The package includes the following categories:
## Categories
- Animals (Cats, Dogs, Penguins; subcategories can be called separately)
- Discord
- Google
- OpenAI
- Research (Biology, Geography, Science, Space; subcategories can be called separately)
- Software
- Urlcut
- Youtube
## Installation
To install the package, run the following command:
```ssh
npm install myfacts
```
## Usage
To use the package, first import the `getFact` function from the package:
```js
// TypeScript: import getFact from "myfacts";
const getFact = require("myfacts");
```
Then, call the `getFact` function with a category parameter to get a random fact from that category:
```js
const fact = getFact("Google");
console.log(fact);
```
This will log a random fact from the Google category to the console. You can replace "Google" with "Software" or "Discord" to get a random fact from those categories instead. More categories listed under the category list
You can also optionally pass an index parameter to `getFact` to get a specific fact from the array:
```js
const fact = getFact("Google", 2);
console.log(fact);
```
This will log the third fact (index 2) from the Google category to the console.
## Contributing
If you'd like to contribute to the package, feel free to submit a pull request with your changes.
## License
MIT License
Copyright (c) 2023 Ducko
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.