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

@dkh-dev/app

v5.1.0

Published

Simple server app

Downloads

135

Readme

@dkh-dev/app

Simple server app

Example

'use strict'

const App = require('@dkh-dev/app')


const app = new App()

app.get({
    '/': () => 'Hello from @dkh-dev/app',
    '/about': () => 'Copyright (c) 2019, dangkyokhoang',
})

app.start()

Reference

Configurations

Note: The default app is shipped with default configurations to make it work out of the box.

app.yaml

server:
    port: <int> [8080]

    keep_alive_timeout: <int> [5000]
    max_body_size: <int> [1000]

logger:
    info: <String> [production ? data/info.log : stdout] // info log
    error: <String> [production ? data/error.log : stderr] // error log
    debug: <String> [production ? null : stdout] // debug log
    <name>: <String> // logger.<name>()
    // request: data/request.log
    // database: data/database.log

database:
    hostname: <String> [localhost]
    port: <int> [27017]

    name: <String>

    user: <String>
    password: <String>

    pool_size: <int> [1]
    ignore_undefined: <bool> [true]

validator:
    strict: <bool> [true]
    remove_additional: <bool> [true]

key:
    size: <int> [64] // must be equal or greater than id size
    encoding: <String> [base64]
    collection_name: <String> [keys]

App

  • app.db: <Db>

    class Db {
      Promise<void> connect() // connects to MongoDB
    
      Collection get <collection>() // returns a MongoDB Collection
      // db.users.find()
      // db.products.insertOne()
    
      void close() // closes the database client
    }
  • app.logger: <Logger>

    class Logger {
      void info() // logs to info log file in production environment
                  //   or to console in development environment
    
      void error()
    
      void debug() // logs to console in development enviroment;
                    //   does nothing in production environment
    
      void <name>() // user-defined log stream
      // logger.request(`requesting ${ url }`)
      // logger.database(`querying ${ collection }`)
    }
  • app.lock() — locks paths; requires authorization: <key> to unlock

    app.lock([
      '/admin',
    ])
  • app.use() — applies middlewares

    app.use({
      '/': log,
    
      // middlewares are fail-safe
      // feel free to throw an error from inside
      '/error': () => {
        throw Error('user wants me to fail')
      },
    })
  • app.schema — defines schemas or registers validator middlewares

    app.schema({
      // definition schemas
    
      story: {
        definitions: {
          id: { type: 'string', maxLength: 20 },
          contents: { type: 'string', maxLength: 1000 },
        },
      },
    
      // validator middlewares
      // keys starting with '/' are paths
    
      '/duplicate': {
        type: 'array',
        items: { type: 'integer' },
      },
    
      '/stories/create': {
        type: 'object',
        properties: {
          contents: { $ref: 'story#/definitions/contents' },
        },
        additionalProperties: false,
      },
    })
  • app.get() — registers GET handlers

    app.get({
      '/': home,
    
      // the return value will be used as the response
      '/random': () => Math.random(),
    
      // async values work
      '/hello': () => Promise.resolve('hello'),
    
      // and so do streams
      '/data': () => fs.createReadStream('data.txt'),
    
      // still you can send response explicitly
      '/write': (request, response) => {
        response.write('text')
      },
    
      // handlers are fail-safe
      // feel free to throw an error from inside
      '/error': () => {
        throw Error('user has requested an error')
      },
    })
  • app.post() — registers POST handlers

    const { HttpError } = require('@dkh-dev/app')
    
    app.post({
      '/unlock': () => true,
    
      // what you post is what you get
      '/duplicate' ({ body }) => duplicate(body),
    
      // handlers are fail-safe
      '/error': ({ body: { code } }) => {
        throw new HttpError(code, `http error`)
      }
    })

Commands

  • npx keygen — generates a key to unlock locked paths

    $ npx keygen --scope '/root /admin' --comment 'root'
    $ npx keygen -s /admin -m admin