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

ts-synology-api

v2.0.38

Published

Api to wrap Syno API wrote in ts, npm package's transpiled in js

Downloads

152

Readme

ts-synology-api

Api to wrap Syno API wrote in ts, npm package's transpiled in js

import Syno from "ts-synology-api";

Coverage

  • [x] api
    • [x] auth
      • [x] key
    • [x] info
  • [x] core
    • [x] normal-user
      • [x] login-notify
  • [ ] download-station
    • [x] info
    • [ ] rss
      • [ ] site
      • [ ] feed
    • [ ] schedule
    • [ ] statistic
    • [x] task
    • [ ] bt-search
  • [ ] dsm
    • [x] info
  • [ ] file-station
    • [x] info
    • [x] list
  • [ ] create a script to get all definitions from a syno to update.

Configuration

# .env for process.env global
SYNOLOGY_URL="http[s]://ip:port"
SYNOLOGY_USER="user"
SYNOLOGY_PASS="passwd"

How Api was build

  • repository 're real path except when 're parameters
  • api request 're save in Index
  • return types 're optionals and save in Type.return
  • params types 're optionals and save in Type.params
  • body params types 're save in Type.body
  • default params 're undefined if needed, they're update with explicite params

How to test


    mkdir test-ts-synology-api && cd test-ts-synology-api
    # globaly install next and typescript
    npm i -g create-next-app typescript
    # create next app in the current folder
    create-next-app ./
    # create typescript config file
    tsc --init
    # run ur next app
    npm run dev
    # he tell u to install some dependencies
    npm install --save-dev typescript @types/react
    # clean ur app
    rm ./pages/**/*.js && rm -rf ./public ./styles
    # create ur .env file with ur config
    # run again ur app
    npm run dev
    # next ll detect ur tsconfig file and autofonfigure him
    # create ur first api file in the api folder and Enjoy 😀

Definition

INFO : /var/packages/DownloadStation - version API : /var/packages/DownloadStation/target/webapi - api's folder LIB : /var/packages/DownloadStation/target/webapi - definition json CGI : /var/packages/DownloadStation/target/webapi - compiled SO : /var/packages/DownloadStation/target/webapi - compiled

INFO

Api's url was updated to respond to the /entry.cgi root: /usr/syno/synoman