@datadog/webpack-plugin 0.0.13-4 → 0.0.13-6

package/README.md

@@ -1 +1,40 @@
-# webpack
+# Datadog Webpack Plugin
+
+A Wepack plugin to interact with Datadog from your Webpack builds.
+
+## Installation
+
+-   Yarn
+
+```bash
+yarn add -D @datadog/webpack-plugin
+```
+
+-   NPM
+
+```bash
+npm install --save-dev @datadog/webpack-plugin
+```
+
+## Usage
+
+Inside your `webpack.config.js`.
+
+```js
+const { datadogWebpackPlugin } = require('@datadog/webpack-plugin');
+
+module.exports = {
+    plugins: [
+        datadogWebpackPlugin({
+            // Configuration
+        }),
+    ],
+};
+```
+
+> [!TIP]
+> It is important to have the plugin in the first position in order to report every other plugins.
+
+## Configuration
+
+Check the main [README](../../README.md#configuration) for the common configuration options.

package/dist/src/index.d.ts

@@ -1,28 +1,24 @@
 import * as webpack from 'webpack';
+import * as src from 'src';
 
+type LogLevel = 'debug' | 'warn' | 'error' | 'none';
 interface GetPluginsOptions {
-    auth: {
-        apiKey: string;
+    auth?: {
+        apiKey?: string;
+        endPoint?: string;
     };
+    logLevel?: LogLevel;
 }
+
+declare const CONFIG_KEY: "telemetry";
+
 interface Metric {
     metric: string;
     type: 'count' | 'size' | 'duration';
     value: number;
     tags: string[];
 }
-
-declare const CONFIG_KEY: "telemetry";
-
 type Filter = (metric: Metric) => Metric | null;
-interface DatadogOptions {
-    apiKey?: string;
-    endPoint?: string;
-    prefix?: string;
-    tags?: string[];
-    timestamp?: number;
-    filters?: Filter[];
-}
 type OutputOptions = boolean | string | {
     destination: string;
     timings?: boolean;
@@ -33,15 +29,22 @@ type OutputOptions = boolean | string | {
 type TelemetryOptions = {
     disabled?: boolean;
     output?: OutputOptions;
-    hooks?: string[];
-    datadog?: DatadogOptions;
+    prefix?: string;
+    tags?: string[];
+    timestamp?: number;
+    filters?: Filter[];
 };
 
 interface Options extends GetPluginsOptions {
     [CONFIG_KEY]?: TelemetryOptions;
 }
+declare const helpers: {
+    telemetry: {
+        filters: ((metric: Metric) => Metric | null)[];
+    };
+};
 
-declare const datadogWebpackPlugin: (options: Options) => webpack.WebpackPluginInstance;
+declare const datadogWebpackPlugin: (options: src.WebpackPluginOptions) => webpack.WebpackPluginInstance;
 
-export { type Options as WebpackPluginOptions, datadogWebpackPlugin };
+export { type Options as WebpackPluginOptions, datadogWebpackPlugin, helpers };
 //# sourceMappingURL=index.d.ts.map