elasticlunr: add type definitions #21779

AbraaoAlves · 2017-11-27T14:59:10Z

Please fill in this template.

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Follow the advice from the readme.
Avoid common mistakes.
Run npm run lint package-name (or tsc if no tslint.json is present).

Select one of these and delete the others:

If adding a new definition:

The package does not provide its own types, and you can not add them.
If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
Create it with dts-gen --dt, not by basing it on an existing project.
tslint.json should be present, and tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

dt-bot · 2017-11-27T14:59:12Z

types/elasticlunr/configuration.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/document_store.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/event_emitter.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/index.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/indexr.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/inverted_indexr.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/pipeline.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/sorted_set.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/stemmer.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/stop_word_filter.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/tokenizer.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/trimmer.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/types.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

types/elasticlunr/utils.d.ts

Checklist

is correct naming convention?
has a test file? (elasticlunr-tests.ts or elasticlunr-tests.tsx)

typescript-bot · 2017-11-27T17:28:02Z

@AbraaoAlves The Travis CI build failed! Please review the logs for more information. Once you've pushed the fixes, the build will automatically re-run. Thanks!

typescript-bot · 2018-01-08T18:16:56Z

After 5 days, no one has reviewed the PR 😞. A maintainer will be reviewing the PR in the next few days and will either merge it or request revisions. Thank you for your patience!

RyanCavanaugh · 2018-01-08T18:31:20Z

types/elasticlunr/elasticlunr-tests.ts

@@ -0,0 +1,40 @@
+import * as elasticlunr from 'elasticlunr';


Classes and functions cannot be imported using import * as syntax. Please fix either the test or the definition file to use a correct import form.

See also https://stackoverflow.com/questions/39415661/what-does-resolves-to-a-non-module-entity-and-cannot-be-imported-using-this

typescript-bot · 2018-01-08T22:09:34Z

@AbraaoAlves Thank you for submitting this PR!

Because this is a new definition, a DefinitelyTyped maintainer will be reviewing this PR in the next few days once the Travis CI build passes.

In the meantime, if the build fails or a merge conflict occurs, I'll let you know. Have a nice day!

ghost · 2018-01-22T16:45:36Z

types/elasticlunr/configuration.d.ts

+      *
+      * @constructor
+      *
+      * @param {String} config user configuration


Don't include types in JSDoc, use TypeScript type declarations instead.

ghost · 2018-01-22T16:45:49Z

types/elasticlunr/configuration.d.ts

+      *
+      * @param {String} config user configuration
+      * @param {Array} fields fields of index instance
+      * @module


This doesn't seem like a module?

ghost · 2018-01-22T16:46:19Z

types/elasticlunr/configuration.d.ts

+      * idx.search('oracle database', {fields: {title: {boost: 2}, body: {boost: 1}}});
+      *
+      *
+      * @constructor


Avoid unnecessary jsdoc tags like @constructor, @module and @memberOf -- this is clearly a constructor, we don't need documentation for that.

ghost · 2018-01-22T16:47:13Z

types/elasticlunr/document_store.d.ts

@@ -0,0 +1,123 @@
+/*!
+ * elasticlunr.DocumentStore
+ * Copyright (C) @YEAR Wei Song


If the type definitions aren't under copyright, this comment shouldn't be included. (If they are, we'll have to review the license before merging.)

ghost · 2018-01-22T16:48:08Z

types/elasticlunr/document_store.d.ts

+     *
+     * @param {Integer|String} docRef document id or reference
+     * @param {String} fieldName field name
+     * @return {Integer} field length


If it returns an integer, the return type should be number.

ghost · 2018-01-22T16:50:00Z

types/elasticlunr/index.d.ts

+// Project: https://github.com/weixsong/elasticlunr.js
+// Definitions by: Abraão Alves <https://github.com/abraaoalves>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.5.2


If possible use a lower version. Also, this can only be 2.X, not 2.X.Y.

ghost · 2018-01-22T16:52:14Z

types/elasticlunr/tslint.json

+  "extends": "dtslint/dt.json",
+  "no-any-union": false,
+  "rules": {
+      "no-any-union": false,


Please re-enable these lint rules, they are important warnings.
A type number | any will be interpreted as just any, so we warn for that. (In general try to avoid using any at all.)

elasticlunr: add package

0d045ab

typescript-bot added the New Definition This PR creates a new definition package. label Nov 27, 2017

typescript-bot added the The Travis CI build failed label Nov 27, 2017

AbraaoAlves mentioned this pull request Nov 30, 2017

Typefy ElasticLunrJS Beakyn/awesome-beakyn#8

Merged

remove tsconfig.json from file list

d5ed96e

ghost mentioned this pull request Jan 2, 2018

Improve error message for unexpected file included in "files" microsoft/types-publisher#419

Merged

typescript-bot added this to Merge: YSYL in Pull Request Triage Backlog Jan 8, 2018

typescript-bot added Unmerged The author did not merge the PR when it was ready. and removed The Travis CI build failed labels Jan 8, 2018

RyanCavanaugh requested changes Jan 8, 2018

View reviewed changes

typescript-bot removed this from Merge: YSYL in Pull Request Triage Backlog Jan 8, 2018

typescript-bot added Revision needed This PR needs code changes before it can be merged. Awaiting reviewer feedback and removed Unmerged The author did not merge the PR when it was ready. labels Jan 8, 2018

ghost suggested changes Jan 22, 2018

View reviewed changes

typescript-bot added The Travis CI build failed and removed Revision needed This PR needs code changes before it can be merged. labels Jan 22, 2018

typescript-bot added Awaiting reviewer feedback and removed Awaiting reviewer feedback labels Feb 26, 2018

typescript-bot removed the Awaiting reviewer feedback label Mar 5, 2018

typescript-bot added the Awaiting reviewer feedback label Mar 13, 2018

aozgaa closed this Mar 16, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

elasticlunr: add type definitions #21779

elasticlunr: add type definitions #21779

AbraaoAlves commented Nov 27, 2017

dt-bot commented Nov 27, 2017

typescript-bot commented Nov 27, 2017 •

edited

Loading

typescript-bot commented Jan 8, 2018

RyanCavanaugh Jan 8, 2018

typescript-bot commented Jan 8, 2018 •

edited

Loading

ghost Jan 22, 2018

ghost Jan 22, 2018

ghost Jan 22, 2018

ghost Jan 22, 2018

ghost Jan 22, 2018

ghost Jan 22, 2018

ghost Jan 22, 2018

elasticlunr: add type definitions #21779

elasticlunr: add type definitions #21779

Conversation

AbraaoAlves commented Nov 27, 2017

dt-bot commented Nov 27, 2017

typescript-bot commented Nov 27, 2017 • edited Loading

typescript-bot commented Jan 8, 2018

Choose a reason for hiding this comment

typescript-bot commented Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Nov 27, 2017 •

edited

Loading

typescript-bot commented Jan 8, 2018 •

edited

Loading