Skip to content

Library to handle curie links provided by hypermedia APIs.

License

Notifications You must be signed in to change notification settings

deepsource/curiejs

Repository files navigation

curiejs

With curiejs you can handle curie links provided by hypermedia (e.g. HATEOAS) APIs.

Install

You can install curiejs with npm:

    npm install curiejs --save

Usage

You can use curiejs in your javascript projects:

    import Curie from 'curiejs'

    // Hypermedia link as provided by hypermedia api (e.g. spring-data-rest)
    const link = "http://localhost:4000/api/entity{?page,size,projection}";

    // Parameters
    const params = { page: 1, projection: 'detail' };

    new Curie(link).toUri(); 
    // --> 'http://localhost:4000/api/entity'

    new Curie(link, params).toUri(); 
    // --> 'http://localhost:4000/api/entity?page=1&projection=detail'

License

Relased under the MIT licence by Sebastian Ullrich (deepsource.de).

Releases

No releases published

Packages

No packages published