1.0.0 • Published 3 years ago

@jacquelinesmith190/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

W02D1 Mon Nov 30 Outline & Notes

(2) Lectures

(1) Work

(19) 6 hrs + 2 hrs stretch

Lotide Refactor Example Refactor tail Refactor eqArrays Refactor assertArraysEqual Refactor middle Incorporate Mocha and Chai Refactor with Mocha and Chai I Exporting All Functions I Exporting All Functions II Object Shorthand in ES6 Implement Object Shorthand Publishing Lotide To npm Submitting Lotide Title Case - Kata Intro to Async Control Flow setTimeout Introduction More Lotide Cleanup Programming Katas Caesar Cipher - Kata Other

(3) POWERED BY Lhl logo

× Congrats on completing activity 'Implement Object Shorthand'! Publishing Lotide To npm Lotide Assignment 35 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.

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).

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.

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.

Create a README.md file within the root of your project (lotide) folder.

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 @jacquelinesmith190/lotide

Require it:

const _ = require('@jacquelinesmith190/lotide');

Call it:

const results = _.tail([1, 2, 3]) // => [2, 3]

Documentation

The following functions are currently implemented:

  • middle(Array): get middle number of array
  • head(Array): get value at first index of an array
  • tail(Array): get all the values of an array except the first one
  • eqArrays(Array1, Array2): find out if 2 arrays are equal