express-well-known

Well-Known Uniform Resource Identifiers

Usage no npm install needed!

<script type="module">
  import expressWellKnown from 'https://cdn.skypack.dev/express-well-known';
</script>

README

Express Middleware for Well-Known URIs

buildCoverage Status CodeFactor npm latest version Known Vulnerabilities Bundle Size TypeScript Types License

Express Middleware for IETF RFC 8615

Features

  • Allows you to register resource schemes to share meta data in a structured way
  • Written in TypeScript

Installation

npm

$ npm install express-well-known --save

yarn

$ yarn add express-well-known

Usage

TypeScript

import * as express from "express";
import { registerURIs } from "express-well-known";

const manifest = {
  application: {
    sha: "4c7e5e667bd30affa2e8c3bc8c65fd38e90912fe",
  },
};

const app = express();
const wellKnown = registerURIs(manifest);
app.use(wellKnown);

JavaScript

const express = require("express");
const { registerURIs } = require("express-well-known");

const manifest = {
  application: {
    sha: "4c7e5e667bd30affa2e8c3bc8c65fd38e90912fe",
  },
};

const app = express();
const wellKnown = registerURIs(manifest);
app.use(wellKnown);

API

registerURIs(Manifest)

returns an express router to mount containing all the well-known resources

References