@microsoft/applicationinsights-perfmarkmeasure-js 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/dist/applicationinsights-perfmarkmeasure-js.api.json

@@ -1,655 +0,0 @@
-{
-  "metadata": {
-    "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.4",
-    "schemaVersion": 1011,
-    "oldestForwardsCompatibleVersion": 1001,
-    "tsdocConfig": {
-      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-      "noStandardTags": true,
-      "tagDefinitions": [
-        {
-          "tagName": "@alpha",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@beta",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@defaultValue",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@decorator",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@deprecated",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@eventProperty",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@example",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@experimental",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@inheritDoc",
-          "syntaxKind": "inline"
-        },
-        {
-          "tagName": "@internal",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@label",
-          "syntaxKind": "inline"
-        },
-        {
-          "tagName": "@link",
-          "syntaxKind": "inline",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@override",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@packageDocumentation",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@param",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@privateRemarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@public",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@readonly",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@remarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@returns",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@sealed",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@see",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@throws",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@typeParam",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@virtual",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@betaDocumentation",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@internalRemarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@preapproved",
-          "syntaxKind": "modifier"
-        }
-      ],
-      "supportForTags": {
-        "@alpha": true,
-        "@beta": true,
-        "@defaultValue": true,
-        "@decorator": true,
-        "@deprecated": true,
-        "@eventProperty": true,
-        "@example": true,
-        "@experimental": true,
-        "@inheritDoc": true,
-        "@internal": true,
-        "@label": true,
-        "@link": true,
-        "@override": true,
-        "@packageDocumentation": true,
-        "@param": true,
-        "@privateRemarks": true,
-        "@public": true,
-        "@readonly": true,
-        "@remarks": true,
-        "@returns": true,
-        "@sealed": true,
-        "@see": true,
-        "@throws": true,
-        "@typeParam": true,
-        "@virtual": true,
-        "@betaDocumentation": true,
-        "@internalRemarks": true,
-        "@preapproved": true
-      },
-      "reportUnsupportedHtmlElements": false
-    }
-  },
-  "kind": "Package",
-  "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!",
-  "docComment": "",
-  "name": "@microsoft/applicationinsights-perfmarkmeasure-js",
-  "preserveMemberOrder": false,
-  "members": [
-    {
-      "kind": "EntryPoint",
-      "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!",
-      "name": "",
-      "preserveMemberOrder": false,
-      "members": [
-        {
-          "kind": "Interface",
-          "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration:interface",
-          "docComment": "/**\n * PerfMarkMeasure Configuration\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface IPerfMarkMeasureConfiguration "
-            }
-          ],
-          "fileUrlPath": "types/interfaces/IPerfMarkMeasureConfiguration.d.ts",
-          "releaseTag": "Public",
-          "name": "IPerfMarkMeasureConfiguration",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#markEndPrefix:member",
-              "docComment": "/**\n * Identifies the prefix for the \"end\" mark of a perf event, defaults to \"ai.prfmrk.end.\", the event name is appended for the mark\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "markEndPrefix?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "markEndPrefix",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#markNameMap:member",
-              "docComment": "/**\n * Provides a mapping between the internal perf names and the value used to create the mark, when a map is provided but no mapping is present that event will be ignored.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "markNameMap?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "{\n        [key: string]: string;\n    }"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "markNameMap",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#markPrefix:member",
-              "docComment": "/**\n * Identifies the prefix for the mark, defaults to \"ai.prfmrk.\", the event name is appended for the mark\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "markPrefix?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "markPrefix",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#measureNameMap:member",
-              "docComment": "/**\n * Provides a mapping between the internal perf names and the value used to create the measure, when no measureNameMap is provided this will default to using the markNameMap and when a map is provided but no mapping is present that event will be ignored.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "measureNameMap?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "{\n        [key: string]: string;\n    }"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "measureNameMap",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#measurePrefix:member",
-              "docComment": "/**\n * Identifies the prefix for the mark, defaults to \"ai.prfmsr.\", the event name is appended for the measure name\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "measurePrefix?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "measurePrefix",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#uniqueNames:member",
-              "docComment": "/**\n * Make the marks and measures unique by appending a numeric value to the prefix value, defaults to false. Marks and measure for the same perfEvent will be assigned the same unique numeric value\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "uniqueNames?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "uniqueNames",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#useEndMarks:member",
-              "docComment": "/**\n * Should the Performance manager create a mark when the event is fired, defaults to false\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "useEndMarks?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "useEndMarks",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#useMarks:member",
-              "docComment": "/**\n * Should the Performance manager create and use window.performance.mark(), defaults to true\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "useMarks?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "useMarks",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration#useMeasures:member",
-              "docComment": "/**\n * Should the Performance manager create and use window.performance.measure(), defaults to true\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "useMeasures?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "useMeasures",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": []
-        },
-        {
-          "kind": "Class",
-          "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!PerfMarkMeasureManager:class",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare class PerfMarkMeasureManager extends "
-            },
-            {
-              "kind": "Reference",
-              "text": "PerfManager",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!PerfManager:class"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "types/PerfMarkMeasureManager.d.ts",
-          "releaseTag": "Public",
-          "isAbstract": false,
-          "name": "PerfMarkMeasureManager",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!PerfMarkMeasureManager:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `PerfMarkMeasureManager` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "constructor(config?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPerfMarkMeasureConfiguration",
-                  "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!IPerfMarkMeasureConfiguration:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", manager?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "INotificationManager",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!INotificationManager:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ");"
-                }
-              ],
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "config",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": true
-                },
-                {
-                  "parameterName": "manager",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": true
-                }
-              ]
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!PerfMarkMeasureManager#create:member(1)",
-              "docComment": "/**\n * Create a new event and start timing, the manager may return null/undefined to indicate that it does not want to monitor this source event.\n *\n * @param src - The source name of the event\n *\n * @param payloadDetails - An optional callback function to fetch the payload details for the event.\n *\n * @param isAsync - Is the event occurring from a async event\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "create(src: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", payload?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", isAsync?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPerfEvent",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IPerfEvent:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": " | null | undefined"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 9
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "src",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "payload",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": true
-                },
-                {
-                  "parameterName": "isAsync",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": true
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "create"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-perfmarkmeasure-js!PerfMarkMeasureManager#fire:member(1)",
-              "docComment": "/**\n * Complete the perfEvent and fire any notifications.\n *\n * @param perfEvent - Fire the event which will also complete the passed event\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "fire(perfEvent: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPerfEvent",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IPerfEvent:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "perfEvent",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "fire"
-            }
-          ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
-        }
-      ]
-    }
-  ]
-}