Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@danguyen/notes

Project: Node Ecosystem

readme

LAB - Class 01

Project: Node Ecosystem

Author: Daniel Nguyen

Documentation

  • [jsdoc]

!Everything below is copied from the old lab. I need to update it!

Modules

pol.js

Exported Values and Methods
isAlive(dead) -> boolean

Returns true/false to indicate how the server works

Setup

.env requirements (where applicable)

  • PORT - Port Number

How to initialize/run your application (where applicable)

  • npm start
  • Endpoint: /
    • Returns a boolean
  • Endpoint: /docs
    • Returns JSDoc Documentation Pages

How to use your library (where applicable)

Tests

  • How do you run tests?
  • Any tests of note?
  • Describe any tests that you did not complete, skipped, etc

  • Unit Tests: npm test

  • Lint Tests: npm run lint

UML

UML Diagram