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

sla-ts

v0.0.8

Published

SLA4API Schema model in TypeScript

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

pjmolinapjmolina

Keywords

sla4apislaopenapi

Readme

SLA-TS

TypeScript library to help building SLA4API compliant API contracts. Provides a model compliant with the schema, and a internal DSL using the builder pattern with capabilities to generate the JSON and YAML version of the SLA contract.

Node.js CI

Conforms to the specification at SLA4API 1.0.0 Draft

Contains

Under src/ you will find:

  • model/ The schema for a valid SLA Document (plans & agreements).
  • dsl/ A utility interanl DSL to build SLA documents.
  • validator/ A validator for SLA documents.
  • cli/ A command line interface to generate documentation an validation for an SLA document.

Install

Locally in your project:

npm i sla-ts --save

Globally as a CLI tool: (planned / not yet)

npm i -g sla-ts

Test

npm test

How to use the CLI

Locally:

npm run cli
npm run cli validate samples/sla1-invalid.json
npm run cli validate samples/sla1.yaml
npm run cli document samples/sla1.yaml samples/sla1.html

As a global tool: (planned / not yet)

sla-ts
sla-ts validate samples/sla1-invalid.json
sla-ts validate samples/sla1.yaml
sla-ts document samples/sla1.yaml samples/sla1.html

Versions & Changelog

See changelog.

References

  • SLA4OAI Spec 1.0.0 https://github.com/isa-group/SLA4OAI-Specification/blob/main/versions/1.0.0-Draft.md
  • SLA4OAI Spec Working Draft https://github.com/isa-group/SLA4OAI-Specification/blob/main/versions/Working-Draft.md
  • OpenAPI spec 3.1.0. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md

License

Licensed under the MIT License.

Credits

Contact: Pedro J. Molina | github: pjmolina | twitter: pmolinam

(c) 2022. Pedro J. Molina at Metadev S.L. https://metadev.pro & contributors.