Skip to content

Commit 8277cd6

Browse files
committed
doc(README): fix syntax example
1 parent 63fe7f3 commit 8277cd6

File tree

4 files changed

+27
-4
lines changed

4 files changed

+27
-4
lines changed

.npmignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
Gruntfile.js
22
.jshintrc
33
.eslintrc
4+
.eslintrc*
45
.travis.yml
6+
.codeclimate.yml
7+
.github
8+
.gitmodules
9+
.release

Changes.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11

22
### Unreleased
33

4+
5+
### [1.1.1] - 2024-01-01
6+
7+
#### Added
8+
9+
-
10+
11+
#### Fixed
12+
13+
-
14+
15+
#### Changed
16+
17+
-
18+
- Merge pull request #21 from msimerson/msimerson-patch-1
19+
- Update publish.yml
20+
421
### 1.1.0 - 2023-12-27
522

623
- doc(README): update CI / badge URLs
@@ -43,3 +60,4 @@
4360

4461

4562
[1.1.0]: https://github.com/msimerson/postfix-parser/releases/tag/1.1.0
63+
[1.1.1]: https://github.com/msimerson/postfix-parser/releases/tag/1.1.1

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Call with a syslog line:
2020

2121
Returns an object:
2222

23-
````js
23+
```js
2424
{
2525
date: 'Jul 5 06:52:11',
2626
host: 'prd-mx1',
@@ -30,7 +30,7 @@ Returns an object:
3030
size: '2666',
3131
nrcpt: '2',
3232
}
33-
````
33+
```
3434

3535
## asObjectType
3636

@@ -44,7 +44,7 @@ requires two positional arguments:
4444
### Typical Usage
4545

4646
```js
47-
const parsed = parser.asObject('syslog', data);
47+
const parsed = parser.asObjectType('syslog', data);
4848
if (!parsed) return; // unparseable syslog line
4949

5050
if (!/^postfix/.test(parsed.prog)) return; // not a postfix line

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"maillog",
99
"mail.log"
1010
],
11-
"version": "1.1.0",
11+
"version": "1.1.1",
1212
"private": false,
1313
"homepage": "https://github.com/msimerson/postfix-parser",
1414
"author": {

0 commit comments

Comments
 (0)