thiliban v1.0.0
Module 1: Week 4 2.857142857142857% Complete 3% Complete Publishing Lotide To npm Lotide Assignment 45 minutes Status Incomplete Wow... We've built a library of functions that we or other developers could actually use in other projects! This is great, but how will these other projects actually import our library?
Much like with Mocha, Chai, Chalk and other packages on npm, we can package up and publish our Lotide library to the public npm registry. In this activity, we'll be doing just that. Exciting!
Creating An NPM Account In order to publish our package to npm, we first need an account on their website. More details on this can be found here.
Instruction Create an NPM account.
Sign up link: https://www.npmjs.com/signup
Your username is important, and we suggest keeping it professional (though it doesn't have to be your name or initials, etc. either).
Instruction Verify your email.
As they say:
You must verify your email address in order to publish packages to the registry.
Logging In To NPM From Vagrant We can now log in using these credentials.
Instruction Log into npm from the command line.
In our Vagrant machine, run the npm login command from any directory. Follow the prompts to login successfully.
Having A README.md File Before we publish our package, there's some best practices housekeeping that we need to follow first.
We need a README.md file. The readme file explains to other developers what this library is for, how to install it, and how to use it.
Instruction Create a README.md file within the root of your project (lotide) folder.
Instruction Paste the following template into README.md.
README Template
Lotide
A mini clone of the Lodash library.
Purpose
BEWARE: This library was published for learning purposes. It is not intended for use in production-grade software.
This project was created and published by me as part of my learnings at Lighthouse Labs.
Usage
Install it:
npm install @username/lotide
Require it:
const _ = require('@username/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
assertArraysEqual
: This function asserts true or false depending on the equality of two arraysassertEqual
: This function asserts true or false depending on the equality of two valuesassertObjectsEqual
: This functions asserts true or false depending on the equality of two objectscountLetters
: This function returns the count of each letter in a stringcountOnly
: This function takes items and returns the count for certain parts of the itemeqArrays
: This function compares two arrayseqObjects
: This function compares two objectsfindKey
: This function scans an object and returns the first keyfindKeyByValue
: This function searches for a key and matches it between two objectsflatten
: This function flattens multiple arrays into a single arrayhead
: This function returns the first element from an arrayindex
: List of all the functionsletterPositions
: This function returns all occurences in the string where a letter is foundmap
: This function creates a new array with resultsmiddle
: This function returns the middle element of an arraytail
: This function returns everything but the first element of an arraytakeUntil
: This function returns a slice of an array with elements taken from the beginningwithout
: This function removes elements from an array
11 months ago