npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@plasma-platform/service-collections

v3.5.0

Published

Collections Service api

Downloads

86

Readme

version nextVersion downloads license dependency


Full documentation
install:
npm i @plasma-platform/service-collections -S

Short documentation

Table of Contents

CollectionsService

  • See: //api.templatemonster.com/collection/v2/

collections Micro Service API that you may adopt for your needs

Parameters

  • url string service url
  • token (string | null) user access tocken if available (optional, default null)

messages

Object with class service messages

Type: Object

getCollectionById

Get collection information specified by collection_id

Parameters

Examples

Read collection info

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const collection = await collections.getCollectionById('hgm1t2ltgyi7dim9nvo0');
})();

Returns Collection collection object

getColectionItemsById

Get list of collection items of collection specified by collection_id

Examples

Read collection items list

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const items = await collections.getColectionItemsById('mfsgxst31slvddqz0miv');
})();

Returns object array of items

getCollectionsOfUser

Get list of collections of user

Parameters

Examples

Get Favorites Collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const items = await collections.getCollectionsOfUser();
})();

Returns object collections

postCollection

Add new collection

Parameters

Examples

Create collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const item = await collections.postCollection('Favorites');
})();

Returns Collection collection object

postItem

Add new collection item

Parameters

Examples

Favorite item

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const item = await collections.postItem('mfsgxst31slvddqz0miv', 'template-67020');
})();

Returns object record in the collection

deleteItem

Delete Collection Item

Parameters

  • id number id of the record in the collection

Examples

Remove from collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  await collections.deleteItem(2342);
})();

getCollections

Get list of collections

Parameters

  • params object object of params.
    • params.page number Page number.
    • params.ids array Array Collection unique ID.
    • params.names array Array Collection Name.
    • params.name string Array Collection unique ID.
    • params.expand string Get additional fields. Collection items are visible only if "expand=items" param is in request

Examples

(async () => {
  const service = new CollectionsService(serviceUrl);
  const collections = await service.getCollections(params);
})();

Returns object collection list & pagination

getMyCollections

Get my list of collections

Parameters

  • params object object of params.
    • params.page number Page number.
    • params.ids array Array Collection unique ID.
    • params.names array Array Collection Name.
    • params.name string Array Collection unique ID.
    • params.expand string Get additional fields. Collection items are visible only if "expand=items" param is in request

Examples

(async () => {
  const service = new CollectionsService(serviceUrl);
  const collections = await service.getCollections(params);
})();

Returns object collection list & pagination

mergeCollections

Collection - Merge Collections

Parameters

  • targetCollectionId string Target collection unique ID.
  • sourceCollectionId string Source collection unique ID.

Examples

(async () => {
  const service = new CollectionsService(serviceUrl);
  const collections = await service.mergeCollections(targetCollectionId, sourceCollectionId);
})();

Returns object collection data