diff --git a/docs/index.html b/docs/index.html index 02268c4..fedd12f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -84,7 +84,7 @@
(Run node -p "process.versions.modules"
to see which Node-ABI in use.)
This repository consists of TypeScript and native dependencies built with node-gyp
. See package.json
for various scripts for the developement process.
This repository consists of TypeScript and native dependencies built with node-gyp
. See package.json
for various scripts for the development process.
For first time building remember to npm install
This repository uses git submodules. If paths are outdated or non-existent run git submodule update --init --recursive
EnPronouncer Pronounces a string, as a General English speaker, into its IPA string or array of Phones format.
matchers module:
FuzzyMatcher Main use case for this library. Returns matches against a list of targets for a given query. The comparisions are not remembered and therefore better for one-off use cases.
+FuzzyMatcher Main use case for this library. Returns matches against a list of targets for a given query. The comparisons are not remembered and therefore better for one-off use cases.
AcceleratedFuzzyMatcher Same interface as FuzzyMatcher
but the list of targets are precomputed, so beneficial for multiple queries at the cost of a higher initialization time.
# Requires native depedencies built, but TypeScript transpiling not required.
+ # Requires native dependencies built, but TypeScript transpiling not required.
npm test
Docs
# Generate the doc files from the docstrings.
@@ -219,8 +219,8 @@ npm run build-docs
# Builds everything, TypeScript & native & docs, as a release build.
npm run release
Deployment/Upload
- Note that the .js library code and native dependencies will be deployed separately. Npm regsitries will be used for the .js code, node-pre-gyp
will be used for prebuilt dependencies while falling back to building on the client.
- # Pushes pack to npmjs.com or a private registry if a .npmrc exisits.
+ Note that the .js library code and native dependencies will be deployed separately. Npm registries will be used for the .js code, node-pre-gyp
will be used for prebuilt dependencies while falling back to building on the client.
+ # Pushes pack to npmjs.com or a private registry if a .npmrc exists.
npm publish
# Packages a ./build/stage/{version}/maluubaspeech-{node_abi}-{platform}-{arch}.tar.gz.
# See package.json:binary.host on where to put it.
diff --git a/package-lock.json b/package-lock.json
index b5e0440..462f478 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "phoneticmatching",
- "version": "0.3.0",
+ "version": "0.3.1",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@@ -71,9 +71,9 @@
"dev": true
},
"@types/jest": {
- "version": "23.3.2",
- "resolved": "https://registry.npmjs.org/@types/jest/-/jest-23.3.2.tgz",
- "integrity": "sha512-D1xlXHZpDonVX+VJ28XtcD5xlu8ex6Fc4cQNnrm2wJvlQnbec9RedhCrhQr6kRAE9XWHSec+JPuTmqJ9jC0qsA==",
+ "version": "23.3.9",
+ "resolved": "https://registry.npmjs.org/@types/jest/-/jest-23.3.9.tgz",
+ "integrity": "sha512-wNMwXSUcwyYajtbayfPp55tSayuDVU6PfY5gzvRSj80UvxdXEJOVPnUVajaOp7NgXLm+1e2ZDLULmpsU9vDvQw==",
"dev": true
},
"@types/lodash": {
@@ -95,9 +95,9 @@
"dev": true
},
"@types/node": {
- "version": "10.11.3",
- "resolved": "https://registry.npmjs.org/@types/node/-/node-10.11.3.tgz",
- "integrity": "sha512-3AvcEJAh9EMatxs+OxAlvAEs7OTy6AG94mcH1iqyVDwVVndekLxzwkWQ/Z4SDbY6GO2oyUXyWW8tQ4rENSSQVQ==",
+ "version": "10.12.2",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-10.12.2.tgz",
+ "integrity": "sha512-53ElVDSnZeFUUFIYzI8WLQ25IhWzb6vbddNp8UHlXQyU0ET2RhV5zg0NfubzU7iNMh5bBXb0htCzfvrSVNgzaQ==",
"dev": true
},
"@types/shelljs": {
@@ -1813,14 +1813,12 @@
"balanced-match": {
"version": "1.0.0",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"brace-expansion": {
"version": "1.1.11",
"bundled": true,
"dev": true,
- "optional": true,
"requires": {
"balanced-match": "^1.0.0",
"concat-map": "0.0.1"
@@ -1835,20 +1833,17 @@
"code-point-at": {
"version": "1.1.0",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"concat-map": {
"version": "0.0.1",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"console-control-strings": {
"version": "1.1.0",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"core-util-is": {
"version": "1.0.2",
@@ -1965,8 +1960,7 @@
"inherits": {
"version": "2.0.3",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"ini": {
"version": "1.3.5",
@@ -1978,7 +1972,6 @@
"version": "1.0.0",
"bundled": true,
"dev": true,
- "optional": true,
"requires": {
"number-is-nan": "^1.0.0"
}
@@ -1993,7 +1986,6 @@
"version": "3.0.4",
"bundled": true,
"dev": true,
- "optional": true,
"requires": {
"brace-expansion": "^1.1.7"
}
@@ -2105,8 +2097,7 @@
"number-is-nan": {
"version": "1.0.1",
"bundled": true,
- "dev": true,
- "optional": true
+ "dev": true
},
"object-assign": {
"version": "4.1.1",
@@ -2118,7 +2109,6 @@
"version": "1.4.0",
"bundled": true,
"dev": true,
- "optional": true,
"requires": {
"wrappy": "1"
}
@@ -2240,7 +2230,6 @@
"version": "1.0.2",
"bundled": true,
"dev": true,
- "optional": true,
"requires": {
"code-point-at": "^1.0.0",
"is-fullwidth-code-point": "^1.0.0",
@@ -3724,9 +3713,9 @@
}
},
"merge": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/merge/-/merge-1.2.0.tgz",
- "integrity": "sha1-dTHjnUlJwoGma4xabgJl6LBYlNo=",
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/merge/-/merge-1.2.1.tgz",
+ "integrity": "sha512-VjFo4P5Whtj4vsLzsYBu5ayHhoHJ0UqNm7ibvShmbmoz7tGi0vXaoJbGdB+GmDMLUdg8DpQXEIeVDAe8MaABvQ==",
"dev": true
},
"merge-stream": {
@@ -5584,9 +5573,9 @@
"dev": true
},
"ts-jest": {
- "version": "23.10.3",
- "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-23.10.3.tgz",
- "integrity": "sha512-Lgyfw1MYPfqAs1qrFBmqXu8LRrde8ItH70pmp1iQuRbkVXaap7QcaEpN+yiSxuppfvO8rqezVv8wOYZkKhR5wA==",
+ "version": "23.10.4",
+ "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-23.10.4.tgz",
+ "integrity": "sha512-oV/wBwGUS7olSk/9yWMiSIJWbz5xO4zhftnY3gwv6s4SMg6WHF1m8XZNBvQOKQRiTAexZ9754Z13dxBq3Zgssw==",
"dev": true,
"requires": {
"bs-logger": "0.x",
@@ -5621,9 +5610,9 @@
"dev": true
},
"semver": {
- "version": "5.5.1",
- "resolved": "https://registry.npmjs.org/semver/-/semver-5.5.1.tgz",
- "integrity": "sha512-PqpAxfrEhlSUWge8dwIp4tZnQ25DIOthpiaHNIthsjEFQD6EvqUKUDM7L8O2rShkFccYo1VjJR0coWfNkCubRw==",
+ "version": "5.6.0",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-5.6.0.tgz",
+ "integrity": "sha512-RS9R6R35NYgQn++fkDWaOmqGoj4Ek9gGs+DPxNUZKuwE183xjJroKvyo1IzVFeXvUrvmALy6FWD5xrdJT25gMg==",
"dev": true
},
"yargs-parser": {
@@ -5708,9 +5697,9 @@
"dev": true
},
"typescript": {
- "version": "3.1.1",
- "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.1.1.tgz",
- "integrity": "sha512-Veu0w4dTc/9wlWNf2jeRInNodKlcdLgemvPsrNpfu5Pq39sgfFjvIIgTsvUHCoLBnMhPoUA+tFxsXjU6VexVRQ==",
+ "version": "3.1.6",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.1.6.tgz",
+ "integrity": "sha512-tDMYfVtvpb96msS1lDX9MEdHrW4yOuZ4Kdc4Him9oU796XldPYF/t2+uKoX0BBa0hXXwDlqYQbXY5Rzjzc5hBA==",
"dev": true
},
"uglify-js": {
diff --git a/package.json b/package.json
index 1e09c2e..a763ce9 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "phoneticmatching",
- "version": "0.3.0",
+ "version": "0.3.1",
"description": "A text utility to do string comparisons at a phonetic level.",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
@@ -34,13 +34,13 @@
"node-pre-gyp"
],
"devDependencies": {
- "@types/jest": "^23.3.2",
- "@types/node": "^10.11.3",
+ "@types/jest": "^23.3.9",
+ "@types/node": "^10.12.2",
"@types/xregexp": "^3.0.29",
"jest": "^23.6.0",
- "ts-jest": "^23.10.3",
+ "ts-jest": "^23.10.4",
"typedoc": "^0.12.0",
- "typescript": "^3.1.1"
+ "typescript": "^3.1.6"
},
"dependencies": {
"node-pre-gyp": "^0.11.0",