Skip to content

Commit cb44be4

Browse files
authored
fix documentation (#18)
Signed-off-by: James Elias Sigurdarson <jamiees2@gmail.com>
1 parent 378744e commit cb44be4

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Built upon [fluent-logger-node](https://github.com/fluent/fluent-logger-node).
1313
$ npm install @fluent-org/logger
1414

1515
## Client
16-
`@fluent-org/logger` provides a fully functional client that implements the Forward protocol. It supports reconnection, acknowledgements, timeouts, event retries, and more, and exposes its functionality through simple typed Promise interface.
16+
`@fluent-org/logger` provides a fully functional client that implements the Forward protocol. It supports reconnection, acknowledgements, timeouts, event retries, and more, and exposes its functionality via a simple typed Promise interface.
1717

1818
For a full list of the client options and methods, see the [FluentClient docs](https://fluent.github.io/fluent-logger-bulk-node/classes/fluentclient.html)
1919

@@ -65,7 +65,7 @@ const logger = new FluentClient("tag_prefix", {
6565

6666
The emit method has following signature
6767

68-
```js
68+
```typescript
6969
emit(data: Record<string, any>): Promise<void>;
7070
emit(data: Record<string, any>, timestamp: number | Date | EventTime): Promise<void>;
7171
emit(label: string, data: Record<string, any>): Promise<void>;
@@ -74,8 +74,8 @@ emit(label: string, data: Record<string, any>, timestamp: number | Date | EventT
7474

7575
The returned Promise is resolved once the event is written to the socket, or rejected if an error occurs.
7676

77-
### Fluentd acknowledgements
78-
The Fluent forward protocol provides explicit support for acknowledgements, which allow the client to be sure that the event reached its destination.
77+
### Acknowledgements
78+
The [Fluent forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1) provides explicit support for acknowledgements, which allow the client to be sure that the event reached its destination.
7979

8080
Enabling acknowledgements means that the promise returned by `emit` will be resolved once the client receives an explicit acknowledgement from the server.
8181
```js
@@ -86,7 +86,7 @@ const logger = new FluentClient("tag_prefix", {
8686
```
8787

8888
### Event modes
89-
The Fluent forward protocol provides multiple message modes, `Message`, `Forward`, `PackedForward`(default), `CompressedPackedForward`. The Fluent client supports all of them.
89+
The [Fluent forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1) provides multiple message modes, `Message`, `Forward`, `PackedForward`(default), `CompressedPackedForward`. The Fluent client supports all of them.
9090

9191

9292
```js

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
},
2323
"repository": {
2424
"type": "git",
25-
"url": "https://github.com/fluent/fluent-logger-bulk-node"
25+
"url": "https://github.com/fluent/fluent-logger-forward-node"
2626
},
27-
"bugs": "https://github.com/fluent/fluent-logger-bulk-node/issues",
28-
"homepage": "https://fluent.github.io/fluent-logger-bulk-node/",
27+
"bugs": "https://github.com/fluent/fluent-logger-forward-node/issues",
28+
"homepage": "https://fluent.github.io/fluent-logger-forward-node/",
2929
"engines": {
3030
"node": ">=12.9.0"
3131
},

0 commit comments

Comments
 (0)