GithubHelp home page GithubHelp logo

vaporjawn / snapple-facts Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 848 KB

Every Snapple Fact

Home Page: https://www.npmjs.com/package/snapple-facts

License: MIT License

JavaScript 52.14% TypeScript 47.86%
facts jest nodejs npm package typescript snapple

snapple-facts's Introduction

Snapple Logo Snapple Facts Snapple Logo

Installation Build Linting Tests Security Scan

GitHub repo forks GitHub repo stars GitHub repo contributorsGitHub org sponsors GitHub repo watchers GitHub repo size

GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) 

Usage

Installation

npm install snapple-facts --save-dev

Usage in Typescript

All the methods that you will need are available in this class

import SnappleFacts from 'snapple-facts';

const snappleFacts = new SnappleFacts();

const randomFact: SnappleFact = snappleFacts.randomFact();

console.log(randomFact);

Available Methods

snappleFacts.randomFact(): SnappleFact;
snappleFacts.getFacts(): SnappleFact[];
snappleFacts.listFacts(): string[];
snappleFacts.getFactByNumber(factNumber: number): SnappleFact | undefined;

Functional Usage

import { RandomFact, GetFacts, ListFacts, GetFactByNumber } from 'snapple-facts';

const randomFact: SnappleFact = RandomFact();
const facts: SnappleFact[] = GetFacts();
const factList: string[] = ListFacts();
const factByNumber: SnappleFact | undefined = GetFactByNumber(1);

Technologies

TypeScriptPrettierESLintJestNodeJSNPM

How To Contribute

Click on these badges to see how you might be able to help:

GitHub repo Issues GitHub repo Good Issues for newbies GitHub Help Wanted issuesGitHub repo PRs GitHub repo Merged PRs GitHub Help Wanted PRs

Installation

Installation

npm install

Running

npm start

or

npm run dev

Testing

Tests

npm test

Building

Build

npm run build

Thanks to all Contributors 💪

  • Thank you for considering to contribute
  • Feel free to submit feature requests, UI updates, bugs as issues.
  • Checkout Contribution Guidelines for more information.
  • Have a feature request? Feel free to create a issue for it.

Contributors

Your Support means a lot

Give a ⭐ to show support for the project.

snapple-facts's People

Contributors

vaporjawn avatar

Stargazers

 avatar  avatar

Watchers

 avatar

snapple-facts's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.