al-quran.reflectslight.io/packages/typescript/postman
2023-06-24 00:01:43 -03:00
..
src Fix build 2023-06-23 22:52:43 -03:00
.gitignore Rename Packet to Postman (#131) 2023-06-23 22:31:25 -03:00
LICENSE Rename Packet to Postman (#131) 2023-06-23 22:31:25 -03:00
package.json Rename Packet to Postman (#131) 2023-06-23 22:31:25 -03:00
README.md postman: update readme 2023-06-24 00:01:43 -03:00
tsconfig.json Rename Packet to Postman (#131) 2023-06-23 22:31:25 -03:00

About

Postman is a TypeScript library that can download the dependencies
of a web page, and afterwards display the web page with all of its
dependencies in-place, ready to use.

An example of a dependency could be a font, an image, a script,
a stylesheet, and a JSON blob. Other formats can be downloaded
as plain-text.

Examples

Progress bar

The following example demonstrates how postman can be used to download
fonts, images, scripts, and stylesheets. The progress of the download is
reported in span.percent. When the download is complete the text
"Done" will replace the progress tracked in span.percent:

/index.html

<!DOCTYPE html>
<head>
  <title>Example page</title>
  <script type="module" src="/postman.js"></script>
</head>
<body>
  <h1> Loading ... <span class="percent"></span></h1>
</body>
</html>

/postman.js

import postman, { item } from "postman";
postman(
  item.font("Kanit Regular", "url(/fonts/kanit-regular.ttf)"),
  item.script("/js/app.js"),
  item.image("/images/app.png"),
  item.css("/css/app.css"),
  item.progress((percent) => {
    const span = document.querySelector("h1 .percent");
    span.innerText = `${percent}%`;
  })
).fetch()
 .then((pkg) => {
    const h1 = document.querySelector("h1");
    pkg.fonts.forEach((font) => documents.fonts.add(font));
    pkg.scripts.forEach((script) => document.body.appendChild(script));
    pkg.css.forEach((css) => document.head.appendChild(css));
    h1.innerText = "Done";
 })

License

BSD Zero Clause.
See LICENSE.