Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JCN-148-corregir-documentacion #2

Merged
merged 2 commits into from
Sep 4, 2019
Merged

JCN-148-corregir-documentacion #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9cfe39
Fixed docs
Sep 3, 2019
2e7f1f1
Fixed parameters order for add method
Sep 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- `README.md` Parameters order for `add` method

## [1.0.0] - 2019-08-07
### Added
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ npm install @janiscommerce/log
```

## API
- `add(log, bucketName)`
Parameters: `log [Object]`, `bucketName [String]`
- `add(bucketName, log)`
Parameters: `bucketName [String]`, `log [Object]`
Puts the recieved log into the specified S3 bucket.

- `on(event, callback)`
Expand All @@ -37,13 +37,13 @@ In case of error while creating your log into S3, this package will emit an even
```js
const Log = require('@janiscommerce/log');

Log.add({
Log.add('my-bucket', {
type: 1,
entity: 'api',
entity_id: 'product',
message: '[GET] Request from 0.0.0.0 of custom_data'
// ...
}, 'my-bucket');
});

Log.on('create-error', (log, err) => {
console.error(`An error occurred while creating the log ${err.message}`);
Expand Down