Giter Club home page Giter Club logo

sortings's Introduction

sortings

JavaScript / TypeScript utility for sorting property and direction

Installation

npm i sortings

Usage

// create Sorting object
const sorting = sortingOf('created_at', 'desc');

// parse from string like "foo,asc"
const parse = (input: string): Sorting | undefined => {
    const [property, direction] = input.split(',');
    if(!isSortingDirection(direction)) {
        return undefined;
    } else {
        return sortingOf(property, direction);
    }
};

// to string
const toString = (sorting: Sorting): string => {
    return sorting.property + "," + sorting.direction;
};

// toggle direction onClick
const handleClick = (): void => {
    this.sorting = toggleSortingDirection(this.sorting);
};

// property name constraints
const sorting: Sorting<'foo' | 'bar'> = {
    property: 'foo',
    direction: 'asc'
};

// parse to generic type with property name constraints
const parse = <T extends string>(input: string, allowedProperties: T[]): Sorting<T> | undefined => {
    const [property, direction] = input.split(',') as [T, string];
    if(!isSortingDirection(direction)) {
        return undefined;
    } else if (!allowedProperties.indexOf(property)) {
        return undefined;
    } else {
        return sortingOf(property, direction);
    }
};

Build

npm run build

Test

npm run test

sortings's People

Contributors

benneq avatar

Watchers

 avatar

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.