You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

koality-guide-client

Package Overview
Dependencies
2
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

koality-guide-client

The KoalityGuide client connects a JavaScript application to the guides.


Version published
Maintainers
1
Created

Readme

Source

JavaScript Client for the Koality Guide.

This client is used to connect to the KoalityClient database and fetch guides for given identifiers.

Important: When fetching data from the KoalityGuide only use this client. The API of the server will change in future, but we try to keep this client compatible as long a possible.

Installation

git clone https://github.com/koality-io/KoalityGuideJsClient
cd KoalityGuideJsClient
npm i

Available Scripts

  • start - run the application within a local,
  • clean - remove coverage data, Jest cache and transpiled files,
  • build - transpile TypeScript to ES2020,
  • dev - interactive watch mode to automatically transpile source files,
  • build:release - clean and transpile source files for production usage,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

Example

const Client = require('../dist/Client')

const koalityGuideClient = new Client('md');

(async () => {
    const guide = await koalityGuideClient.getGuide('html.deadlink.404', 'de')
    console.log('Language: ', guide.getLanguage())
    console.log('Text: ', guide.getText())
})()

For more examples see the /examples directory.

Features

  • Fallback language: when creating a new client a fallback language can be added. If no guide for the actual language was found the client will return the fallback language guide if exists.
  • Multi format: in future it will be possible to fetch the guide in multiple formats. We will start with markdown (md) and html.

To do

  • Access control: Use tokens to gain access to the KoalityGuide server.
  • Overwrite axios: It should be possible to inject an axios client with custom settings.
  • Multiple KoalityGuide servers: KoalityGuide could be a framework or server detached from the content it is offers. So there could be many servers.
  • Recommendations: If you read this guide, this one could alo be interesting.
  • Directory: Show all guides for a whole directory.

FAQs

Package last updated on 04 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc