Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit 4e30114

Browse files
committed
fix readme table
1 parent 5d99866 commit 4e30114

File tree

4 files changed

+14
-20
lines changed

4 files changed

+14
-20
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,21 @@ app.listen(3000, () => {
3838
});
3939
```
4040

41-
where `<API-KEY>` is the API key which can be generated from your [apitoolkit.io](apitoolkit.io) account
42-
4341
#### Quick overview of the configuration parameters
4442

4543
An object with the following optional fields can be passed to the middleware to configure it:
4644

47-
{class="docs-table"} :::
48-
| Option | Description | | ------ | ----------- |
49-
| `debug` | Set to `true` to enable debug mode. |
50-
| `serviceName` | A defined string name of your application.|
51-
| `tags` | A list of defined tags for your services (used for grouping and filtering data on the dashboard). |
52-
| `serviceVersion` | A defined string version of your application (used for further debugging on the dashboard). |
53-
| `redactHeaders` | A list of HTTP header keys to redact. |
54-
| `redactResponseBody` | A list of JSONPaths from the response body to redact. |
55-
| `redactRequestBody` | A list of JSONPaths from the request body to redact. |
56-
| `captureRequestBody` | default `false`, set to true if you want to capture the request body. |
57-
| `captureResponseBody` | default `false`, set to true if you want to capture the response body. |
58-
:::
45+
| Option | Description |
46+
|----------------------|-----------------------------------------------------------------------------------------------|
47+
| `debug` | Set to `true` to enable debug mode. |
48+
| `serviceName` | A defined string name of your application. |
49+
| `tags` | A list of defined tags for your services (used for grouping and filtering data on the dashboard). |
50+
| `serviceVersion` | A defined string version of your application (used for further debugging on the dashboard). |
51+
| `redactHeaders` | A list of HTTP header keys to redact. |
52+
| `redactResponseBody` | A list of JSONPaths from the response body to redact. |
53+
| `redactRequestBody` | A list of JSONPaths from the request body to redact. |
54+
| `captureRequestBody` | Default `false`, set to `true` if you want to capture the request body. |
55+
| `captureResponseBody`| Default `false`, set to `true` if you want to capture the response body. |
5956

6057
<br />
6158

lib/apitoolkit.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { NextFunction, Request, Response } from 'express';
22
import { ReportError } from 'apitoolkit-js';
3-
export { ReportError } from 'apitoolkit-js';
43
type Config = {
54
serviceName?: string;
65
debug?: boolean;

lib/apitoolkit.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
"use strict";
22
Object.defineProperty(exports, "__esModule", { value: true });
3-
exports.reportError = exports.ReportError = void 0;
3+
exports.reportError = void 0;
44
exports.expressMiddleware = expressMiddleware;
55
exports.expressErrorHandler = expressErrorHandler;
66
const uuid_1 = require("uuid");
77
const api_1 = require("@opentelemetry/api");
88
const payload_1 = require("apitoolkit-js/lib/payload");
99
const apitoolkit_js_1 = require("apitoolkit-js");
10-
var apitoolkit_js_2 = require("apitoolkit-js");
11-
Object.defineProperty(exports, "ReportError", { enumerable: true, get: function () { return apitoolkit_js_2.ReportError; } });
1210
function expressMiddleware(config) {
1311
if (!config) {
1412
config = {};

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)