callsite-record - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "callsite-record",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Create fancy call site records for any function up in the stack for the logging purposes.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -59,5 +59,8 @@ # callsite-record
 ```js
-console.log(record.render());
+record.render().then(str => console.log(str));
 ```
 
+#### CallsiteRecord.renderSync([renderOptions]) → String
+Sync version of the `CallsiteRecord.render`.
+
 ##### renderOptions.frameSize
@@ -68,7 +71,7 @@ Specifies the number of lines rendered above and below the call site in the code frame. **Default:** `5`.
 ```js
-console.log(record.render({ frameSize: 0 }));
+console.log(record.renderSync({ frameSize: 0 }));
 // > 12 |    func1();
 // ...
 
-console.log(record.render({ frameSize: 1 }));
+console.log(record.renderSync({ frameSize: 1 }));
 //   11 |(function func2() {
@@ -80,6 +83,6 @@ // > 12 |    func1();
 
-#### renderOptions.stack
+##### renderOptions.stack
 Specifies if stack trace should be rendered in addition to the code frame. **Default:** `true`.
 
-#### renderOptions.stackFilter
+##### renderOptions.stackFilter
 Function that will be used to filter stack frames. Function accepts 2 arguments:
@@ -96,6 +99,6 @@ - `stackFrame` - V8 [CallSite](https://github.com/v8/v8/wiki/Stack-Trace-API#customizing-stack-traces) object.
 // Remove node core lib calls from the stack trace
-record.render({ stackFilter: frame => frame.getFileName().indexOf(sep) > -1 });
+record.renderSync({ stackFilter: frame => frame.getFileName().indexOf(sep) > -1 });
 ```
 
-#### renderOptions.renderer
+##### renderOptions.renderer
 Specifies the output format of the rendering. **Default:** `renderers.default`. You can pass your own
@@ -105,3 +108,3 @@ renderer object ([example implementations](https://github.com/inikulin/callsite-record/tree/master/lib/renderers)) or use
 
-##### renderers.default
+###### renderers.default
 Provides ANSI-colored output as shown above.
@@ -113,6 +116,6 @@
 
-record.render({ renderer: defaultRenderer });
+record.renderSync({ renderer: defaultRenderer });
 ```
 
-##### renderers.noColor
+###### renderers.noColor
 Same as `default` renderer but without colors.
@@ -124,6 +127,6 @@
 
-record.render({ renderer: noColorRenderer });
+record.renderSync({ renderer: noColorRenderer });
 ```
 
-##### renderers.html
+###### renderers.html
 Outputs HTML that can be later decorated with the CSS and embeded into the web page. [Example output](https://github.com/inikulin/callsite-record/blob/master/test/data/expected-html/0.html).
@@ -135,7 +138,5 @@
 
-record.render({ renderer: html });
+record.renderSync({ renderer: html });
 ```
 
-#### CallsiteRecord.renderSync([renderOptions]) → String
-Sync version of the `CallsiteRecord.render`.
 
@@ -142,0 +143,0 @@ ## Related

No alert changes

Improved metrics

Total package byte prevSize

15477

increased by0.31%

Number of lines in readme file

141

increased by0.71%

No dependency changes