Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cressie176 committed Sep 25, 2023
1 parent e2ec879 commit b027f5b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,13 @@ We call `unref` to ensure the scheduled scans to not prevent your application fr

- [Installation](#installation)
- [API](#api)
- [Constructor](#Constructor)
- [Constructor](#scanneroptions--scanneroptions)
- [init](#init--promise)
- [scan](#scan--promise)
- [Stats](#stats)
- [Contributing](#contributing)
- [License](#license)


### Installation

Expand Down Expand Up @@ -83,15 +86,15 @@ import { Scanner } from 'pg-scanner';
| config | No | A configuration object which is passed directly to [node-pg](https://www.npmjs.com/package/pg). Alternatively, you can use [environment variables](https://node-postgres.com/features/connecting#environment-variables) if you prefer. |
| filter | No | A function for filtering out unwanted tables. It will be called with an object with a table and schema property and should return truthy if the table is to be included in the statistics |
### init() : Promise<void>
### init() : Promise&lt;void&gt;
```js
await scanner.init();
```
The init method is responsible for initialising the scanner wise baseline statistics. It will error if called repeatedly.
### scan() : Promise<Stats>
### scan() : Promise&lt;Stats&gt;
```js
await scanner.scan();
Expand Down

0 comments on commit b027f5b

Please sign in to comment.