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

@dvcol/synology-http-client

v1.1.2

Published

Simple fetch based http client for Synology API with full typescript support (request and response).

Downloads

3

Readme

Simple fetch based http client for Synology API with full typescript support (request and response).

Prerequisites

  • pnpm >=9.0.0
  • node >=20.0.0

Install

pnpm install

Usage

pnpm add @dvcol/synology-http-client

Modular endpoint bundling

synology-http-client is designed to be modular and flexible. Although it uses static classes, endpoints are instantiated at runtime and can be easily omitted, extended or overridden. If your bundler does not support tree-shaking, you can omit unused endpoints by only importing the ones you need.

By default we provide a full api object with all supported endpoints, as well as a minimal api object with only the essential authentication endpoints. You can also import any endpoint by common scope.

import { SynologyClient } from '@dvcol/synology-http-client';

import { download } from '@dvcol/synology-http-client/api/download';
import { file } from '@dvcol/synology-http-client/api/file';
import { minimalSynologyApi } from '@dvcol/synology-http-client/api/minimal';
import { Config } from '@dvcol/synology-http-client/config';

import type { SynologyClientSettings } from '@dvcol/synology-http-client/models';

export const api = {
  ...minimalSynologyApi,
  download,
  file
};

export const settings: SynologyClientSettings = {
  name:'<Your client name>',
  endpoint: Config.endpoint,
  
  corsProxy: '<Optional cors Proxy>',
  corsPrefix: '<Optional cors Proxy prefix>',
};

const authenticaiton = {}

const client = new SynologyClient(settings, authenticaiton, api);

Features

Documentation

See Synology API documentation for more information.

Author

📝 License

This project is MIT licensed.