Installation

npm install --save @types/listify

Summary

This package contains type definitions for listify (https://github.com/ljharb/listify#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/listify.

index.d.ts

1export = listify;
2
3/**
4 * Turn an array into a list of comma-separated values, appropriate for use in an English sentence.
5 *
6 * @example
7 * import listify = require('listify');
8 * import * as assert from 'node:assert';
9 *
10 * assert(listify([1, 2]) === '1 and 2');
11 * assert(listify([1, 2, 3]) === '1, 2, and 3');
12 * assert(listify([1, 2, 3, 4]) === '1, 2, 3, and 4');
13 * assert(listify([1, 2, 3], { separator: '… ' }) === '1… 2… and 3');
14 * assert(listify([1, 2, 3], { finalWord: false }) === '1, 2, 3');
15 * assert(listify([1, 2, 3], { separator: '… ', finalWord: 'or' }) === '1… 2… or 3');
16 */
17declare function listify(list: ReadonlyArray<string | number>, options?: listify.Options): string;
18
19declare namespace listify {
20    interface Options {
21        /**
22         * @default ', '
23         */
24        separator?: string;
25        /**
26         * @default 'and'
27         */
28        finalWord?: string | false;
29    }
30}
31

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:38 GMT
• Dependencies: none

Credits

These definitions were written by BendingBender.