Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 9 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,22 @@ yarn add mdb-reader

To decrypt databases, this library requires a few dependencies:

- [`browserify-aes`](https://www.npmjs.com/browserify-aes): Only imported when running in browser
- [`create-hash`](https://www.npmjs.com/create-hash): Only imported when running in browser
- [`fast-xml-parser`](https://www.npmjs.com/fast-xml-parser)

## Usage

```javascript
import { readFileSync } from "fs";
import MDBReader from "mdb-reader";
import { createMDBReader } from "mdb-reader";

const buffer = readFileSync("database.mdb");
const reader = new MDBReader(buffer);
const reader = await createMDBReader(buffer);

reader.getTableNames(); // ['Cats', 'Dogs', 'Cars']
await reader.getTableNames(); // ['Cats', 'Dogs', 'Cars']

const table = reader.getTable("Cats");
const table = await reader.getTable("Cats");
table.getColumnNames(); // ['id', 'name', 'color']
table.getData(); // [{id: 5, name: 'Ashley', color: 'black'}, ...]
await table.getData(); // [{id: 5, name: 'Ashley', color: 'black'}, ...]
```

## Examples
Expand All @@ -77,17 +75,7 @@ table.getData(); // [{id: 5, name: 'Ashley', color: 'black'}, ...]
### MDBReader

```typescript
class MDBReader {
/**
* @param buffer Buffer of the database.
*/
constructor(
buffer: Buffer,
options?: {
password?: string;
}
);

interface MDBReader {
/**
* Date when the database was created
*/
Expand Down Expand Up @@ -118,14 +106,14 @@ class MDBReader {
normalTables: boolean;
systemTables: boolean;
linkedTables: boolean;
}): string[];
}): Promise<string[]>;

/**
* Returns a table by its name.
*
* @param name Name of the table. Case sensitive.
*/
getTable(name: string): Table;
getTable(name: string): Promise<Table>;
}
```

Expand Down Expand Up @@ -180,7 +168,7 @@ class Table {
columns?: ReadonlyArray<TColumn>;
rowOffset?: number;
rowLimit?: number;
}): TRow[];
}): Promise<TRow[]>;
}
```

Expand Down
1 change: 0 additions & 1 deletion global.d.ts

This file was deleted.

Loading