@ifct2017/codes - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

index.d.ts

+export interface Code {
+  /** Food Name. */
+  name: string,
+  /** Food Code. */
+  code: string
+}
+
+
+/**
+ * Loads corpus to enable queries.
+ * [📦](https://www.npmjs.com/package/@ifct2017/codes)
+ * @returns corpus {name ⇒ {name, code}}
+ */
+export function load(): Promise<Map<string, Code>>;
+
+
+/**
+ * Generates PostgreSQL statements for creating table w/ data.
+ * [📦](https://www.npmjs.com/package/@ifct2017/codes)
+ * @returns CREATE TABLE, INSERT, CREATE VIEW, CREATE INDEX statements
+ */
+ export function sql(tab: string='codes', opt: object={}): Promise<string>;
+
+
+/**
+ * Gives path of CSV data file.
+ * [📦](https://www.npmjs.com/package/@ifct2017/codes)
+ * @returns .../index.csv
+ */
+ export function csv(): string;
+
+
+/**
+ * Finds matching codes of an name/code query.
+ * [📦](https://www.npmjs.com/package/@ifct2017/codes)
+ * @param txt name/code query
+ * @returns matches [{name, code}]
+ * @example
+ * ```javascript
+ * codes('mango green');
+ * codes('Raw mango');
+ * // [ { name: 'Mango, green, raw (Common)', code: 'D057' } ]
+ *
+ * codes('what is food code of atta?');
+ * codes('atta code');
+ * // [ { name: 'Atta (H., P.)', code: 'A019' },
+ * //   { name: 'Gahama atta (O.)', code: 'A019' },
+ * //   { name: 'Wheat flour, atta (Common)', code: 'A019' } ]
+ * ```
+ */
+function codes(txt: string): [Code];
+export = codes;

package.json

 {
   "name": "@ifct2017/codes",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Uniquely identifiable codes for each food.",
@@ -5,0 +5,0 @@ "main": "index.js",

No alert changes

Improved metrics

Total package byte prevSize

86522

1.63%

Number of package files

6

20%

Lines of code

111

65.67%

No dependency changes