nuǝW pǝuoᴉʇᴉsoԀ ʎlǝʌᴉʇɐƃǝN

npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

sno-pack

0.0.5 • Public • Published

SnoPack

Install Documentation

Sno-pack provides tools for building and publishing a snobject in NodeJS.

Properties

Type Description Required
version Snobject.version ✅ Yes
license Snobject.license No
getSchema Snobject.getSchema ✅ Yes
name Snobject.SnoPack.name ✅ Yes
keywords Snobject.SnoPack.keywords No
homepage string The url to the project homepage. No
bugs Snobject.SnoPack.bugs No
author Snobject.SnoPerson No
contributors array[] A list of people who contributed to this package. No
maintainers array[] A list of people who maintains this package. No
files Snobject.SnoPack.files No
main string The main field is a module ID that is the primary entry point to your program. No, default: "./src/main.js"
bin string,object undefined No
man array,string Specify either a single file or an array of filenames to put in place for the man program to find. No
directories Snobject.SnoPack.directories No
repository Snobject.SnoPack.repository No
scripts object The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point. No
config Snobject.SnoPack.config No
dependencies Snobject.SnoPack.dependency No
peerDependencies Snobject.SnoPack.dependency No
optionalDependencies Snobject.SnoPack.dependency No
bundledDependencies Snobject.SnoPack.bundledDependency No
bundleDependencies Snobject.SnoPack.bundledDependency No
engines object undefined No
engineStrict boolean undefined No
os string[] undefined No
cpu string[] undefined No
preferGlobal boolean If your package is primarily a command-line application that should be installed globally, then set this value to true to provide a warning if it is installed locally. No
private boolean If set to true, then npm will refuse to publish it. No
publishConfig object undefined No
get Snobject.SnoPack.get ✅ Yes
add Snobject.SnoPack.add ✅ Yes
set Snobject.SnoPack.set ✅ Yes
addSchema Snobject.addSchema ✅ Yes
validate Snobject.validate ✅ Yes
getClass Snobject.SnoPack.getClass ✅ Yes
buildSchema Snobject.SnoPack.buildSchema ✅ Yes
buildMD Snobject.SnoPack.buildMD ✅ Yes

Pattern Properties

Type Description Required
^_ Any property starting with _ is valid. No

Additional properties are allowed.

SnoPack.version ✅

  • Type: Snobject.version
  • Required: Yes

SnoPack.license

  • Type: Snobject.license
  • Required: No

SnoPack.getSchema ✅

  • Type: Snobject.getSchema
  • Required: Yes

SnoPack.name ✅

  • Type: Snobject.SnoPack.name
  • Required: Yes

SnoPack.keywords

  • Type: Snobject.SnoPack.keywords
  • Required: No

SnoPack.homepage

The url to the project homepage.

  • Type: string
  • Required: No
  • Format: uri

SnoPack.bugs

  • Type: Snobject.SnoPack.bugs
  • Required: No

SnoPack.author

  • Type: Snobject.SnoPerson
  • Required: No

SnoPack.contributors

A list of people who contributed to this package.

  • Type: array[]
  • Required: No

SnoPack.maintainers

A list of people who maintains this package.

  • Type: array[]
  • Required: No

SnoPack.files

  • Type: Snobject.SnoPack.files
  • Required: No

SnoPack.main

The main field is a module ID that is the primary entry point to your program.

  • Type: string
  • Required: No, default: "./src/main.js"

SnoPack.bin

  • Type: string,object
  • Required: No
  • Type of each property: string

SnoPack.man

Specify either a single file or an array of filenames to put in place for the man program to find.

  • Type: array,string
  • Required: No

SnoPack.directories

  • Type: Snobject.SnoPack.directories
  • Required: No

SnoPack.repository

  • Type: Snobject.SnoPack.repository
  • Required: No

SnoPack.scripts

The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.

  • Type: object
  • Required: No
  • Type of each property: string

SnoPack.config

  • Type: Snobject.SnoPack.config
  • Required: No

SnoPack.dependencies

  • Type: Snobject.SnoPack.dependency
  • Required: No

SnoPack.peerDependencies

  • Type: Snobject.SnoPack.dependency
  • Required: No

SnoPack.optionalDependencies

  • Type: Snobject.SnoPack.dependency
  • Required: No

SnoPack.bundledDependencies

  • Type: Snobject.SnoPack.bundledDependency
  • Required: No

SnoPack.bundleDependencies

  • Type: Snobject.SnoPack.bundledDependency
  • Required: No

SnoPack.engines

  • Type: object
  • Required: No
  • Type of each property: string

SnoPack.engineStrict

  • Type: boolean
  • Required: No

SnoPack.os

  • Type: string[]
  • Required: No

SnoPack.cpu

  • Type: string[]
  • Required: No

SnoPack.preferGlobal

If your package is primarily a command-line application that should be installed globally, then set this value to true to provide a warning if it is installed locally.

  • Type: boolean
  • Required: No

SnoPack.private

If set to true, then npm will refuse to publish it.

  • Type: boolean
  • Required: No

SnoPack.publishConfig

  • Type: object
  • Required: No

SnoPack.get ✅

  • Type: Snobject.SnoPack.get
  • Required: Yes

SnoPack.add ✅

  • Type: Snobject.SnoPack.add
  • Required: Yes

SnoPack.set ✅

  • Type: Snobject.SnoPack.set
  • Required: Yes

SnoPack.addSchema ✅

  • Type: Snobject.addSchema
  • Required: Yes

SnoPack.validate ✅

  • Type: Snobject.validate
  • Required: Yes

SnoPack.getClass ✅

  • Type: Snobject.SnoPack.getClass
  • Required: Yes

SnoPack.buildSchema ✅

  • Type: Snobject.SnoPack.buildSchema
  • Required: Yes

SnoPack.buildMD ✅

  • Type: Snobject.SnoPack.buildMD
  • Required: Yes

install

npm i sno-pack

Downloadsweekly downloads

5

version

0.0.5

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability