@capacitor-firebase/performance 6.1.0 → 6.3.0

package/dist/docs.json

@@ -113,6 +113,170 @@
           "IsEnabledResult"
         ],
         "slug": "isenabled"
+      },
+      {
+        "name": "putAttribute",
+        "signature": "(options: PutAttributeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PutAttributeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Sets a custom attribute of a trace to a given value.",
+        "complexTypes": [
+          "PutAttributeOptions"
+        ],
+        "slug": "putattribute"
+      },
+      {
+        "name": "getAttribute",
+        "signature": "(options: GetAttributeOptions) => Promise<GetAttributeResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetAttributeOptions"
+          }
+        ],
+        "returns": "Promise<GetAttributeResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Returns the value of a custom attribute of a trace.",
+        "complexTypes": [
+          "GetAttributeResult",
+          "GetAttributeOptions"
+        ],
+        "slug": "getattribute"
+      },
+      {
+        "name": "getAttributes",
+        "signature": "(options: GetAttributesOptions) => Promise<GetAttributesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetAttributesOptions"
+          }
+        ],
+        "returns": "Promise<GetAttributesResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Gets the all the custom attributes of a trace with their values.",
+        "complexTypes": [
+          "GetAttributesResult",
+          "GetAttributesOptions"
+        ],
+        "slug": "getattributes"
+      },
+      {
+        "name": "removeAttribute",
+        "signature": "(options: RemoveAttributeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetAttributeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Removes a custom attribute from a trace given its name.",
+        "complexTypes": [
+          "RemoveAttributeOptions"
+        ],
+        "slug": "removeattribute"
+      },
+      {
+        "name": "putMetric",
+        "signature": "(options: PutMetricOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PutMetricOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Sets the value of a custom metric.",
+        "complexTypes": [
+          "PutMetricOptions"
+        ],
+        "slug": "putmetric"
+      },
+      {
+        "name": "getMetric",
+        "signature": "(options: GetMetricOptions) => Promise<GetMetricResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetMetricOptions"
+          }
+        ],
+        "returns": "Promise<GetMetricResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Get the value of a custom metric by name.",
+        "complexTypes": [
+          "GetMetricResult",
+          "GetMetricOptions"
+        ],
+        "slug": "getmetric"
+      },
+      {
+        "name": "record",
+        "signature": "(options: RecordOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RecordOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.3.0"
+          }
+        ],
+        "docs": "Records a trace given its name and options.\n\nOnly available on web.",
+        "complexTypes": [
+          "RecordOptions"
+        ],
+        "slug": "record"
       }
     ],
     "properties": []
@@ -270,9 +434,373 @@
           "type": "boolean"
         }
       ]
+    },
+    {
+      "name": "PutAttributeOptions",
+      "slug": "putattributeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to set its attribute.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "attribute",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            },
+            {
+              "text": "\"experiment\"",
+              "name": "example"
+            }
+          ],
+          "docs": "Name of the attribute to set its value.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            },
+            {
+              "text": "\"A\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The value to set to the attribute.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetAttributeResult",
+      "slug": "getattributeresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The value of the custom attribute.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetAttributeOptions",
+      "slug": "getattributeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to set its attribute.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "attribute",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the attribute to retrieve its value.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetAttributesResult",
+      "slug": "getattributesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "attributes",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A map of all custom attributes of a trace with their values.",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; }"
+        }
+      ]
+    },
+    {
+      "name": "GetAttributesOptions",
+      "slug": "getattributesoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to get its attributes.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PutMetricOptions",
+      "slug": "putmetricoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to set its metric.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "metricName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The metric name.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "num",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The value to set for the metric.\nThe given value is floored down to the nearest integer.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "GetMetricResult",
+      "slug": "getmetricresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The value of the metric if exists.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "GetMetricOptions",
+      "slug": "getmetricoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to get its metric.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "metricName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The metric name.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "RecordOptions",
+      "slug": "recordoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "traceName",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Name of the trace to record.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "startTime",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Start time of the trace since epoch in milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "duration",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The duration of the trace in milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "options",
+          "tags": [
+            {
+              "text": "6.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An optional object that holds optional maps of custom metrics and attributes.",
+          "complexTypes": [],
+          "type": "{ metrics?: { [key: string]: number; } | undefined; attributes?: { [key: string]: string; } | undefined; } | undefined"
+        }
+      ]
     }
   ],
   "enums": [],
-  "typeAliases": [],
+  "typeAliases": [
+    {
+      "name": "RemoveAttributeOptions",
+      "slug": "removeattributeoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "GetAttributeOptions",
+          "complexTypes": [
+            "GetAttributeOptions"
+          ]
+        }
+      ]
+    }
+  ],
   "pluginConfigs": []
 }