Skip to content

Commit f313aa4

Browse files
committed
docs: Add README entries for moduleMetadata and applicationKey
1 parent a136133 commit f313aa4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Diff for: packages/dev-utils/src/generate-documentation-table.ts

+12
Original file line numberDiff line numberDiff line change
@@ -355,6 +355,18 @@ type IncludeEntry = {
355355
},
356356
],
357357
},
358+
{
359+
name: "moduleMetadata",
360+
type: "Record<string, any> | (args: { org?: string; project?: string; release?: string; }) => Record<string, any>",
361+
fullDescription:
362+
"Metadata that should be associated with the built application.\n\nThe metadata is serialized and can be looked up at runtime from within the SDK (for example in the `beforeSend`, event processors, or the transport), allowing for custom event filtering logic or routing of events.\n\nMetadata can either be passed directly or alternatively a callback can be provided that will be called with the following parameters:\n\n- `org`: The organization slug.\n- `project`: The project slug.\n- `release`: The release name.",
363+
},
364+
{
365+
name: "applicationKey",
366+
type: "string",
367+
fullDescription:
368+
"A key which will embedded in all the bundled files. The SDK will be able to use the key to apply filtering rules, for example using the `thirdPartyErrorFilterIntegration`.",
369+
},
358370
{
359371
name: "_experiments",
360372
type: "string",

0 commit comments

Comments
 (0)