-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
56 lines (48 loc) · 1.41 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
export interface Content {
/** S. No. */
sno: string,
/** Title. */
title: string,
/** Page Nos. */
pagenos: string
}
/**
* Loads corpus to enable queries.
* [📦](https://www.npmjs.com/package/@ifct2017/contents)
* @returns corpus {sno ⇒ {sno, title, pagenos}}
*/
export function load(): Map<string, Content>;
/**
* Generates PostgreSQL statements for creating table w/ data.
* [📦](https://www.npmjs.com/package/@ifct2017/contents)
* @returns CREATE TABLE, INSERT, CREATE VIEW, CREATE INDEX statements
*/
export function sql(tab: string='contents', opt: object={}): string;
/**
* Gives path of CSV data file.
* [📦](https://www.npmjs.com/package/@ifct2017/contents)
* @returns .../index.csv
*/
export function csv(): string;
/**
* Finds matching contents of an sno/title/pagenos query.
* [📦](https://www.npmjs.com/package/@ifct2017/contents)
* @param txt sno/title/pagenos query
* @returns matches [{sno, title, pagenos}]
* @example
* ```javascript
* contents('table 2');
* contents('Water soluble vitamins');
* // [ { sno: '6.2.',
* // title: 'Table 2: Water Soluble Vitamins',
* // pagenos: '31' } ]
*
* contents('what is page number of table 3?');
* contents('fat soluble vitamin page number');
* // [ { sno: '6.3.',
* // title: 'Table 3: Fat Soluble Vitamins',
* // pagenos: '61' } ]
* ```
*/
function contents(txt: string): [Content];
export = contents;