WH

Documenting Apis

Nestjs provides a more opinionated way in expressing structure when developing a backend for your Node.js application, and this prescribed way of doing things coupled with the usage of TypeScript allows for better maintainable code.

As stated in their project README.md:

Nest aims to provide an application architecture out of the box which allows for effortless creation of highly testable, scalable, loosely coupled and easily maintainable applications. The architecture is heavily inspired by Angular.

Inline Variables Within a Paragraph

For general reuse, one can reference another file in reStructuredText using the include directive.

.. main.rst - this document will the insert the external content from the path below

.. include:: the/path/to/my-included-file.rst

This is good when the content which you want to embed directly into your document can stand by itself as a separate paragraph, however, if you wish to embed content inline within an existing paragraph, it would be necessary to place the included content as variables in another document with the following example.

CLI Wrap with Spawn and Programmatic Access

Oclif is a Nodejs command line generator tool that grants you the ability to conveniently create a CLI with the following

npx oclif single mycoollistofthings

Supposedly you have your own custom CLI, but you wish to delegate some of these commands to an existing CLI tool. You are then wrapping another CLI command for the intent of adding additional functionality with mycoollistofthings. Here is the new command's mapping behavior of the ls -r command.

npx mycoollistofthings -r

Fluent API

As with many JavaScript libraries, asynchronous operations are dealt with using promises, and the commonly preferred way of structuring promises flows entails the use of async / await.

From the Playwright documentation

const { webkit } = require('playwright');

(async () => {
  const browser = await webkit.launch();
  const page = await browser.newPage();
  await page.goto('http://whatsmyuseragent.org/');
  await page.screenshot({ path: `example.png` });
  await browser.close();
})();

Every page operation will require the use of an await since each yields a promise. However, this simple example shows the extra effort needed to tame async control flow by having to prepend each operation with an await. This is a bit noisy and detracts from the true intent of the tests steps.

Chapter Links

As a LateX document accumulates more content, navigating to a specific piece of information would be cumbersome if there was not an easy way to quickly jump to the area of interest. Providing a table of contents in the beginning of the document will greatly enhance the ability to find relevant data.

Rxdeep

For the easier determination of a value change inside a deeply nested object, use Rxdeep's state's output observable for wrapping an object to subscribe to the change events.

import { state } from 'rxdeep';
 
const s = state([ { name: 'John' }, { name: 'Jack' }, { name: 'Jill' } ]);

// Listen to changes on 'name' property of index 1 on the list:
s.sub(1).sub('name').subscribe(console.log);     // --> logs `Jack`

Render Full Html Site

By default, converting a LaTeX file into an HTML file only produces a partial HTML page. Pandoc conversion strictly contains the content wrapped in the basic HTML equivalent tags, which is spartan as the following example would only output a paragraph tag without a html, head, nor body tag available.

\documentclass{article}

\usepackage[margin=0.5in]{geometry}
\title{Tex}
\date{}

\begin{document}
\maketitle

some content

\end{document}

To fix this problem, the "full html" page requires the "-s" flag (standalone mode) to achieve the proper conversion.

pandoc -o 'my-output-file.html' 'my-input-file.tex' -s