Skip to content

Commit 6e34b2c

Browse files
chore(release): 2.3.0 [skip ci]
# [2.3.0](v2.2.0...v2.3.0) (2019-06-21) ### Bug Fixes * add .DS_Store to gitignore ([968bd50](968bd50)) ### Features * add `log.result()` method ([3b98ec3](3b98ec3)) ### Performance Improvements * switch to fast-safe-stringify to increase performance ([3f5fa59](3f5fa59))
1 parent 616619c commit 6e34b2c

3 files changed

Lines changed: 41 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# [2.3.0](https://github.com/KyleRoss/node-lambda-log/compare/v2.2.0...v2.3.0) (2019-06-21)
2+
3+
4+
### Bug Fixes
5+
6+
* add .DS_Store to gitignore ([968bd50](https://github.com/KyleRoss/node-lambda-log/commit/968bd50))
7+
8+
9+
### Features
10+
11+
* add `log.result()` method ([3b98ec3](https://github.com/KyleRoss/node-lambda-log/commit/3b98ec3))
12+
13+
14+
### Performance Improvements
15+
16+
* switch to fast-safe-stringify to increase performance ([3f5fa59](https://github.com/KyleRoss/node-lambda-log/commit/3f5fa59))
17+
118
# [2.2.0](https://github.com/KyleRoss/node-lambda-log/compare/v2.1.0...v2.2.0) (2019-03-20)
219

320

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ const log = new LambdaLog();
130130
* [log.&lt;info|warn|error|debug|*&gt;(msg, [meta], [tags])](#LambdaLog+&lt;info|warn|error|debug|*&gt;)[<code>LogMessage</code>](#LogMessage)
131131
* [log.log(level, msg, [meta], [tags])](#LambdaLog+log)[<code>LogMessage</code>](#LogMessage) \| <code>Boolean</code>
132132
* [log.assert(test, msg, [meta], [tags])](#LambdaLog+assert)[<code>LogMessage</code>](#LogMessage) \| <code>Boolean</code>
133+
* [log.result(promise, [meta], [tags])](#LambdaLog+result)[<code>Promise.&lt;LogMessage&gt;</code>](#LogMessage)
133134
* Event: [log](#LambdaLog+event_log)
134135

135136
<a name="new_LambdaLog_new"></a>
@@ -267,6 +268,28 @@ results = [1, 2, 3];
267268
log.assert(results, 'No results provided!');
268269
//=> false
269270
```
271+
<a name="LambdaLog+result"></a>
272+
273+
### log.result(promise, [meta], [tags]) ⇒ [<code>Promise.&lt;LogMessage&gt;</code>](#LogMessage)
274+
Generates a log message with the result or error provided by a promise. Useful for debugging and testing.
275+
276+
**Kind**: instance method of [<code>LambdaLog</code>](#LambdaLog)
277+
**Returns**: [<code>Promise.&lt;LogMessage&gt;</code>](#LogMessage) - A new Promise that resolves with the LogMessage object after the promise completes.
278+
**Since**: 2.3.0
279+
280+
| Param | Type | Default | Description |
281+
| --- | --- | --- | --- |
282+
| promise | <code>Promise</code> | | A promise or promise-like object to retrieve a value from. |
283+
| [meta] | <code>Object</code> | <code>{}</code> | Optional meta data to attach to the log. |
284+
| [tags] | <code>Array</code> | <code>[]</code> | Additional tags to append to this log. |
285+
286+
**Example**
287+
```js
288+
let promise = new Promise(resolve => resolve('this is a test'));
289+
290+
log.result(promise);
291+
// => { "msg": "this is a test" ... }
292+
```
270293
<a name="LambdaLog+event_log"></a>
271294

272295
### Event: log

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "lambda-log",
3-
"version": "2.2.0",
3+
"version": "2.3.0",
44
"description": "Basic logging mechanism for Node 6.10+ Lambda Functions",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)