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

ibm-connections-files

v1.1.1

Published

An implementation for the IBM Connections Files API

Downloads

2

Readme

IBM Connections Files Service

an implementation for the IBM Connections Files API

Install

$ npm install --save ibm-connections-files-service

Usage

After you require files service, you may easily setup the default properties.

const ibmConnectionsFilesService = require('ibm-connections-files-service');

const defaults = {
  headers: {
    Authorization: 'Basic 12345', // or any other auth method
  },
};

Beside default authorization, this service supports oniyi-http-plugin-credentials and oniyi-http-plugin-format-url-template.

Credentials plugin is used only if plugins.credentials is provided.

Format-url-template is used by default, and it is recommended to use it in combination with credentials plugin.

For more details about plugins usage, please visit:

oniyi-http-plugin-credentials

oniyi-http-plugin-format-url-template

const plugins = {
  credentials: {
    providerName: 'customProvider',
    userRelationProp: 'credentials',
  },
  formatUrlTemplate: {
    valuesMap: {
      authType: {
        basic: 'customAuthType', 
      }
    },
  },
};

const serviceOptions = {
  defaults,
  plugins,
  baseUrl: 'https://fake.base.url.com',
};

const service = ibmConnectionsFilesService(serviceOptions.baseUrl, serviceOptions);

Once source instance is created, you are able to use next methods:

1. service.myFiles
2. service.publicFiles
3. service.communityFiles
4. service.filesFromFolder

Every method comes with three arguments, query, options and callback.

query - valid query parameters about each method can be found in the source code: /lib/methods/* options - additional options merged into default http request params

1. service.myFiles

In order to retrieve personal files, prepare configuration and make a call:

const query = {
  customQuery: 'query value',
};

const options = {
    customOptions: 'some value',
};

service.myFiles(query, options, (err, response) => {
  const { files } = response;
  
  // use files object to retrieve data about personal files
});

2. service.publicFiles

Similar preparation as for the myFiles method:

const query = {
  customQuery: 'query value',
};

const options = {
    customOptions: 'some value',
};

service.publicFiles(query, options, (err, response) => {
  const { files } = response;
  
  // use files object to retrieve data about public files
});

3. service.communityFiles

When you need to retrieve files that belong to a certain community, it is necessary to provide the communityId:

const query = {
  communityId: '123-foo-456-bar',
};

const options = {
    customOptions: 'some value',
};

service.communityFiles(query, options, (err, response) => {
  const { files } = response;
  
  // use files object to retrieve files from community
});

4. service.filesFromFolder

And when you need to retrieve files that belong to a folder/collection, it is necessary to provide the collectionId:

const query = {
  collectionId: '123-foo-456-bar',
};

const options = {
    customOptions: 'some value',
};

service.filesFromFolder(query, options, (err, response) => {
  const { files } = response;
  
  // use files object to retrieve files from folder/collection
});

License

UNLICENSED © GIS AG