Skip to content

A partial port of lodash and test suit to TypeScript for the Deno JavaScript runtime.

License

Notifications You must be signed in to change notification settings

thesmart/nodash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nodash

A partial port of lodash and test suit to TypeScript for the Deno JavaScript runtime.

Project goals:

  • have the most identical port of lodash implementation (line-by-line)
  • have the most identical test suite (line-by-line) of lodash
  • not a complete lodash port: only the parts needed in ECMA 6
  • fully typed in TypeScript and passes deno lint
  • can import individual functions (_ symbol is optional, i.e. "nodash")
  • each release tag of nodash will reference a lodash release tag

Changes from Lodash

  • many public functions have been excluded if an equivalent ECMA 6 feature exists
  • get, has, etc. no longer take path: Array<string|symbol>, only path: string
  • private function _caseFirst has a different signature

Usage

For the bold:

import {
  isEmpty,
  isNull,
  isUndefined,
} from "https://deno.land/x/nodash/src/mod.ts";

For the familiar:

import * as _ from "https://deno.land/x/nodash/src/mod.ts";

Project status:

  • Partial Lang port of all "is" functions (e.g. isString, isEmpty, etc.)
  • Partial Lang port of "to" functions:
    • toFinite
    • toInteger
    • toNumber
    • toSafeInteger
    • toString
  • Function
    • debounce
    • throttle
  • Object
    • get
    • has
    • set
    • unset
  • String
    • deburr
    • camelCase
    • capitalize
    • kebabCase
    • lowerCase
    • snakeCase
    • startCase
    • upperCase
    • words

Contributions

✨💎✨ Contributions are welcome. ✨💎✨

For additional ports, please:

  1. open an issue w/ proposal
  2. open a PR w/ code contribution (linked to issue)
  3. include all relevant tests from lodash (ported)
  4. pass deno lint and run deno fmt

nodash-cli

To update the mod.ts file:

# scans all ./src/**/*.ts files for exported functions w/ @export jsdoc tags
./nodash-cli --update-mod