beemovie
TypeScript icon, indicating that this package has built-in type declarations

1.0.4 • Public • Published

beemovie v1.0.4

A Bee Movie generator as a Node.js library written in TypeScript.

Installation

npm

npm install beemovie --save

yarn

yarn add beemovie

Building

Clone the repo with this command:

git clone https://github.com/roosterchicken/beemovie

and cd into the directory and run this command to build the .js files into the dist folder.

npm run build

Functions

Sentence()

The Sentence() function generates a sentence by picking a sentence randomly from the Bee Movie script.

Script()

The Script() function prints out the entire Bee Movie script.

Word()

The Word() function generates a random word from the Bee Movie script.

Paragraph()

The Paragraph() function generates a random sentence by generating 3-5 sentences either with a period or a question mark.

Version()

The Version() function prints out the version of the library.

Usage

JavaScript

Sentence()

const beemovie = require("beemovie");
// Prints out 1 sentence
console.log(beemovie.Sentence(1));
// Prints out 2 sentences
console.log(beemovie.Sentence(2));

Script()

const beemovie = require("beemovie");
// Prints out the entire Bee Movie Script
console.log(beemovie.Script());

Word()

const beemovie = require("beemovie");
// Prints out a word from the Bee Movie
console.log(beemovie.Word(1));

Paragraph()

const beemovie = require("beemovie");
// Prints out a 3-5 sentence paragraph
console.log(beemovie.Paragraph());
// Prints out 2 3-5 sentence paragraphs
console.log(beemovie.Paragraph(2));

Version()

const beemovie = require("beemovie");
// Saves the output of the beemovie.Version() function into the variable barryversion
const barryversion = beemovie.Version();
console.log(`You are running beemovie v${barryversion}`);

TypeScript

Sentence()

import beemovie from "beemovie";
// Prints out 1 sentence
console.log(beemovie.Sentence(1));
// Prints out 2 sentences
console.log(beemovie.Sentence(2));

Script()

import beemovie from "beemovie";
// Prints out the entire Bee Movie Script
console.log(beemovie.Script());

Word()

import beemovie from "beemovie";
// Prints out a word from the Bee Movie
console.log(beemovie.Word(1));

Paragraph()

import beemovie from "beemovie";
// Prints out a 3-5 sentence paragraph
console.log(beemovie.Paragraph());
// Prints out 2 3-5 sentence paragraphs
console.log(beemovie.Paragraph(2));

Version()

import beemovie from "beemovie";
// Saves the output of the beemovie.Version() function into the variable barryversion
const barryversion = beemovie.Version();
console.log(`You are running beemovie v${barryversion}`);

Package Sidebar

Install

npm i beemovie

Weekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

227 kB

Total Files

57

Last publish

Collaborators

  • rooster-chicken