docs: ✏️ JSDoc

Author: lrodrigues-newstore

packages/interpolate/README.md

@@ -12,36 +12,6 @@ Super simple microtemplating.
 yarn add @pacote/interpolate
 ```
 
-## Usage
-
-```typescript
-import { interpolate } from '@pacote/interpolate'
-
-const render = interpolate('Hello, {{ name }}!')
-
-render({ name: 'world' }) // => "Hello, world!"
-```
-
-### `interpolate(template: string, pattern?: RegExp) => (data?: { [key: string]: string } | string[]) => string`
-
-`interpolate()` takes a string template and returns a function that accepts an object or array containing the placeholders as properties and the strings to replace them with as values. Note that all the function does is substitute placeholders, it does not handle loops, conditionals or perform character escaping.
-
-The returned function also accepts an array of values. In this case, the placeholder is expected to be the numerical index of the array value to use:
-
-```typescript
-const render = interpolate('Hello, {{0}} and {{1}}!')
-
-render(['Alice', 'Bob']) // => "Hello, Alice and Bob!"
-```
-
-`interpolate()` optionally receives a pattern expression in order to customise the placeholder delimiters. This pattern _must_ have a single capture group. For example:
-
-```typescript
-const render = interpolate('Hello, %{name}!', /%{([\s\S]+?)}/)
-
-render({ name: 'world' }) // => "Hello, world!"
-```
-
 ## License
 
 MIT © [Luís Rodrigues](https://goblindegook.com).

packages/interpolate/src/index.ts

@@ -1,5 +1,42 @@
 type ReplaceMap<T> = { [placeholder: string]: T } | T[]
 
+/**
+ * Creates a renderer that substitutes placeholders in a template with values
+ * provided at call time.
+ *
+ * The returned function accepts either an object keyed by placeholder names or
+ * an array of values, in which case placeholders are numeric indices. Only raw
+ * substitution is performed—no escaping, looping, or conditional logic.
+ *
+ * @param template Template containing placeholders to replace.
+ * @param pattern  Pattern describing the placeholder delimiters. Defaults to
+ *                 `/{{([\s\S]+?)}}/`. May be a string or `RegExp` and must
+ *                 contain exactly one capture group for the placeholder key.
+ *
+ * @returns Function that receives replacement data and yields the interpolated
+ *          string.
+ *
+ * @example
+ * ```typescript
+ * const render = interpolate('Hello, {{ name }}!')
+ *
+ * render({ name: 'world' }) // => 'Hello, world!'
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const render = interpolate('Hello, {{0}} and {{1}}!')
+ *
+ * render(['Alice', 'Bob']) // => 'Hello, Alice and Bob!'
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const render = interpolate('Hello, %{name}!', /%{([\s\S]+?)}/)
+ *
+ * render({ name: 'world' }) // => 'Hello, world!'
+ * ```
+ */
 export function interpolate(
   template: string,
   pattern: RegExp | string = /{{([\s\S]+?)}}/,