Git Product home page Git Product logo

jslib-extensions's Introduction

version package size

What is this?

This is a personal library used to extend the standard JS library with more prototype methods and getters. This is not intended to be used for serious projects as prototype method extensions of built-ins are normally frowned upon since they can collide with each other. To at least minimize collisions, all extension methods are prefixed with $.

Install

npm install @ferdaber/jslib-extensions

Usage

This library only supports ES Modules.

import "@ferdaber/jslib-extensions"
// Now new prototype methods will be available for arrays, objects, numbers, strings and sets.

Development

This project uses Yarn as its package manager.

Setup

yarn install

Testing

yarn test

Reference

Array

declare interface Array<T> {
  $first: T
  $last: T
  $empty: boolean

  $compact(): Exclude<T, null | undefined | false | "" | 0>[]
  $strip(): NonNullable<T>[]
  $unique(): T[]
  $reverse(): T[]

  $idx(n: number): number
  $at(n: number): T
  $splice(startIdx: number, deleteCount?: number): T[]
  $splice(startIdx: number, deleteCount: number, ...items: T[]): T[]
  $insertAt(idx: number, ...items: T[]): T[]
  $removeAt(idx: number, numItems?: number): T[]
  $shift(numItems?: number): T[]
  $pop(numItems?: number): T[]
  $push(...items: T[]): T[]
  $unshift(...items: T[]): T[]
  $sort(sortFn?: (a: T, b: T) => number): T[]
}

declare interface ArrayConstructor {
  $range(length: number): number[]
  $range(start: number, end: number): number[]
  $tuple<T extends any[]>(...args: T): T
}

Number

declare interface Number {
  $isInside(low: number, high: number): boolean
  $isBetween(low: number, high: number): boolean
  $approxEquals(other: number, tolerance?: number): boolean
  $clamp(low: number, high: number): number
}

declare interface Math {
  $randomInt(low: number): number
  $randomInt(low: number, high: number): number
}

Object

declare interface Object {
  $strip<T>(this: T, stripNulls?: boolean): T
  $is<T>(other: unknown): other is T
  $iss<T>(other: unknown): other is T
}

declare interface ObjectConstructor {
  $isObject(x: unknown): x is object
  $isRecord(x: unknown): x is object
}

Set

declare interface Set<T> {
  $empty: boolean

  $asArray(): T[]
  $add(...values: T[]): Set<T>
  $remove(...values: T[]): Set<T>
  $filter(filterFn: (value: T) => boolean): Set<T>
  $toggle(...values: T[]): Set<T>
}

String

declare interface String {
  $empty: boolean

  $capitalize(): string
  $truncate(maxLength: number): string
  $ellipsize(maxLength: number): string
}

declare interface StringConstructor {
  $uuid(): string
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.