-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
52 lines (44 loc) · 1.45 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
export interface Representation {
/** Type of physical quantity. */
type: string,
/** Multiplication factor. */
factor: number,
/** Unit symbol. */
unit: string;
}
/**
* Loads corpus to enable queries.
* [📦](https://www.npmjs.com/package/@ifct2017/representations)
* @returns corpus {code ⇒ {type, factor, unit}}
*/
export function load(): Map<string, Representation>;
/**
* Generates PostgreSQL statements for creating table w/ data.
* [📦](https://www.npmjs.com/package/@ifct2017/representations)
* @returns CREATE TABLE, INSERT, CREATE VIEW, CREATE INDEX statements
*/
export function sql(tab: string='representations', opt: object={}): string;
/**
* Gives path of CSV data file.
* [📦](https://www.npmjs.com/package/@ifct2017/representations)
* @returns .../index.csv
*/
export function csv(): string;
/**
* Finds matching representations of a column:code/name/tags query.
* [📦](https://www.npmjs.com/package/@ifct2017/representations)
* @param txt column:code/name/tags query
* @returns found ⇒ {type, factor, unit}, else null
* @example
* ```javascript
* representations('his');
* representations('Histidine');
* // { type: 'mass', factor: 1000, unit: 'mg' }
*
* representations('representation of vitamin d?');
* representations('what is unit of ergocalciferol?');
* // { type: 'mass', factor: 1000000000, unit: 'ng' }
* ```
*/
function representations(txt: string): Representation | null;
export = representations;