hellion

1.0.8 • Public • Published

Markdown is NOT complete as of version 1.0.8. I am still working on it, so not everything is explained!!! I am also aware that the generations are not working. I will fix that very soon!

Usage for Hellion -

Install Hellion first - $ npm install hellion

Then require Hellion in your code -

var hellion = require('hellion')

Updates in Hellion v1.0.8

  • Updated README file
  • Added some array functions

How to use conversions in Hellion

You can convert from unit to unit using the hellion.convert() function. Hellion is a flexible library, so there are 8 ways to convert from one unit to another.

Example - Convert 2.54 centimeters to inches

Here are all the ways we could accomplish this goal

hellion.convert("2.54 cm to in")
hellion.convert("2.54 centimeters to inches")
hellion.convert("2.54 cm to inches")
hellion.convert("2.54 centimeters to in")
hellion.convert("2.54 cm in")
hellion.convert("2.54 centimeters inches")
hellion.convert("2.54 cm inches")
hellion.convert("2.54 centimeters in")

All conversions in Hellion are based off of the symbols for the units of measurement, so centimeters would have its "symbol" represented as cm and inches as in, for example.

Current List of supported conversions (constantly getting updated) -

  • centimeters to inches
  • centimeters to feet
  • centimeters to yards
  • centimeters to miles
  • centimeters to nautical miles
  • cemtimeters to nanometers
  • centimeters to micrometers
  • centimeters to millimeters
  • centimeters to decimeters
  • centimeters to meters
  • centimeters to dekameters
  • centimeters ot hectometers
  • centimeters to kilometers
  • decimeters to inches
  • decimeters to feet
  • decimeters tp yards
  • decimeters to miles
  • decimeters to nautical miles
  • decimeters to nanometers
  • decimeters to micrometers
  • decimeters to millimeters
  • decimeters to centimeters
  • decimeters to meters
  • decimeters to dekameters
  • decimeters to hectometers
  • decimeters to kilometers

Date Functions

  • hellion.year() - returns the current year in your time zone
  • hellion.month() - returns the current month in your time zone
  • hellion.date() - returns the current date in your time zone
  • hellion.hour() - returns the current hour in your time zone
  • hellion.minute() - returns the current minute in your time zone
  • hellion.second() - returns the current second in your time zone
  • hellion.millisecond() - returns the current millisecond in your time zone
  • hellion.day() - returns the current day in your time zone
  • hellion.time() - returns the full time

Array Methods

Here is a list of all the current array methods in hellion (definitions based off of w3schools.com Array Reference)

  • hellion.concat(array1, array2) - Joins two arrays, and returns a copy of the joined arrays.
  • hellion.merge(array1, array2) - Refer to the hellion.concat() function.
  • hellion.join(array1, array2) - Refer to the hellion.concat() function.
  • hellion.copyWithin(array, target, start, end) - Copies array elements within the array, to and from specified positions (https://www.w3schools.com/JSREF/jsref_copywithin.asp for more info).
  • hellion.copyIn(array, target, start, end) - Refer to the hellion.copyWithin() function.
  • hellion.entries(array) - Returns a key/value pair Array Iteration Object (https://www.w3schools.com/JSREF/jsref_entries.asp for more info).
  • hellion.valuePairs(array) - Refer to the hellion.entries() function.
  • hellion.keyPairs(array) - Refer to the hellion.entres() function.

Generations

The generation feature syntax of Hellion goes somewhat like this -

hellion.{object}.generate()

Example - Generate a random noun

hellion.noun.generate()

Example (multi-word object) - Generate a vocabulary word

hellion.vocabulary_word.generate()

Here is a full list of all the generations currently supported by Hellion

  • Colleges - hellion.college.generate()
  • Presidents - hellion.president.generate()
  • Cocktails - hellion.cocktail.generate()
  • Fruits - hellion.fruit.generate()
  • Ice Cream Flavors - hellion.ice_cream.generate()
  • Ingredients - hellion.ingredient.generate()
  • Restaurants - hellion.restaurant.generate()
  • Body Parts - hellion.body_part.generate()
  • Colors - hellion.color.generate()
  • Mythic Gods - hellion.god.generate()
  • Months - hellion.month.generate()
  • Phobias - hellion.phobia.generate()
  • Common Sayings - hellion.saying.generate()
  • Things - hellion.thing.generate()
  • Topics - hellion.topic.generate()
  • Cat Names - hellion.cat_name.generate()
  • Male Names - hellion.male_name.generate()
  • Middle Names - hellion.middle_name.generate()
  • Pet Names - hellion.pet_name.generate()
  • Team Names - hellion.team_name.generate()
  • Adjectives - hellion.adjective.generate()
  • Adverbs - hellion.adverb.generate()
  • Nouns - hellion.noun.generate()
  • Prepositions - hellion.preposition.generate()
  • Verbs - hellion.verb.generate()
  • Spanish Last Names - hellion.spanish_last_name.generate()
  • Spanish Words - hellion.spanish_word.generate()
  • Athletes - hellion.athlete.generate()
  • MLS Teams - hellion.mls_team.generate()
  • NCAA Teams - hellion.ncaa_team.generate()
  • NHL Teams - hellion.nhl_team.generate()
  • Wrestlers - hellion.wrestler.generate()
  • Compound Words - hellion.compound_word.generate()
  • Vocabulary Words - hellion.vocabulary_word.generate()
  • Words - hellion.word.generate()

If you have any questions or you find something wrong/have any suggestions for improvement, hit me up on Discord - Stevano#1771

Hellion v1.0.8

Package Sidebar

Install

npm i hellion

Weekly Downloads

0

Version

1.0.8

License

ISC

Unpacked Size

1.73 MB

Total Files

71

Last publish

Collaborators

  • mrslurpyboi