restream - npm Package Compare versions

Comparing version 3.7.0 to 3.7.1

build/index.js

@@ -52,3 +52,3 @@ const { Transform } = require('stream');
  * @suppress {nonStandardJsDocs}
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): string} _restream.Replacer
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): string} _restream.Replacer
  */
@@ -61,3 +61,3 @@ /**
  * @suppress {nonStandardJsDocs}
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): !Promise<string>} _restream.AsyncReplacer
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): !Promise<string>} _restream.AsyncReplacer
  */
@@ -81,4 +81,5 @@ /**
  * @typedef {Object} _restream.ReplaceableInterface An interface for the context accessible via this in replacer functions.
+ * @prop {function(string, ...*)} emit Emit an event. Inherited from the `EventEmitter` which _Replaceable_ extends.
  * @prop {function()} brake After calling this method, the following rules and matches within the same rule won't be able to make any more changes.
- * @prop {function(string, !Object<string, *>?): !Promise<string>} replace Creates a new _Replaceable_ by copying all rules, assigns the context to it and replaces the data. The `this` won't be shared by rules, but the context will be updated: `const context = { test: this.test }; content = await this.replace(content, context); this.test = context.test`.
+ * @prop {function(string, !Object<string, *>=): !Promise<string>} replace Creates a new _Replaceable_ by copying all rules, assigns the context to it and replaces the data. The `this` won't be shared by rules, but the context will be updated: `const context = { test: this.test }; content = await this.replace(content, context); this.test = context.test`.
  */
@@ -85,0 +86,0 @@

CHANGELOG.md

 ## 20 April 2019
 
+### [3.7.1](https://github.com/artdecocode/restream/compare/v3.7.0...v3.7.1)
+
+- [types] Fix broken types with `this: !` and `function(opt?)`; add `emit` method to the interface.
+
 ### [3.7.0](https://github.com/artdecocode/restream/compare/v3.6.0...v3.7.0)
@@ -4,0 +8,0 @@

externs.js

@@ -15,7 +15,7 @@ /* typal types/markers.xml */
 /**
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): string}
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): string}
  */
 _restream.Replacer
 /**
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): !Promise<string>}
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): !Promise<string>}
  */
@@ -28,4 +28,4 @@ _restream.AsyncReplacer
 /**
- * @typedef {{ brake: function(), replace: function(string, !Object<string, *>?): !Promise<string> }}
+ * @typedef {{ emit: function(string, ...*), brake: function(), replace: function(string, !Object<string, *>=): !Promise<string> }}
  */
 _restream.ReplaceableInterface

package.json

 {
   "name": "restream",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "description": "Regular Expression Detection & Replacement streams.",
@@ -5,0 +5,0 @@ "main": "build/index.js",

src/index.js

@@ -52,3 +52,3 @@ import { Transform } from 'stream'
  * @suppress {nonStandardJsDocs}
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): string} _restream.Replacer
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): string} _restream.Replacer
  */
@@ -61,3 +61,3 @@ /**
  * @suppress {nonStandardJsDocs}
- * @typedef {function(this:!_restream.ReplaceableInterface, ...string): !Promise<string>} _restream.AsyncReplacer
+ * @typedef {function(this:_restream.ReplaceableInterface, ...string): !Promise<string>} _restream.AsyncReplacer
  */
@@ -81,4 +81,5 @@ /**
  * @typedef {Object} _restream.ReplaceableInterface An interface for the context accessible via this in replacer functions.
+ * @prop {function(string, ...*)} emit Emit an event. Inherited from the `EventEmitter` which _Replaceable_ extends.
  * @prop {function()} brake After calling this method, the following rules and matches within the same rule won't be able to make any more changes.
- * @prop {function(string, !Object<string, *>?): !Promise<string>} replace Creates a new _Replaceable_ by copying all rules, assigns the context to it and replaces the data. The `this` won't be shared by rules, but the context will be updated: `const context = { test: this.test }; content = await this.replace(content, context); this.test = context.test`.
+ * @prop {function(string, !Object<string, *>=): !Promise<string>} replace Creates a new _Replaceable_ by copying all rules, assigns the context to it and replaces the data. The `this` won't be shared by rules, but the context will be updated: `const context = { test: this.test }; content = await this.replace(content, context); this.test = context.test`.
  */

No alert changes

Improved metrics

Total package byte prevSize

78594

increased by0.56%

Lines of code

912

increased by0.22%

No dependency changes