Class TagMap

Package version

TagMap is maps of TagKey -> TagValueWithMetadata

Hierarchy

TagMap

Index

Properties

Methods

delete
set

Properties

tags

tags: Map<TagKey, TagValue>

Gets the tags map without metadata.

tagsWithMetadata

tagsWithMetadata: Map<TagKey, TagValueWithMetadata>

Gets the tags map with metadata.

Methods

delete

delete(tagKey: TagKey): void

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/tags/tag-map.d.ts:31
Deletes a tag from the map if the key is in the map.

Parameters
- tagKey: TagKey
  
  The TagKey which will be removed.
Returns void

set

set(tagKey: TagKey, tagValue: TagValue, tagMetadata?: TagMetadata): void

- Defined in home/vsts/work/1/s/common/temp/node_modules/.registry.npmjs.org/@opencensus/web-types/0.0.7/node_modules/@opencensus/web-types/build/src/tags/tag-map.d.ts:26
Adds the key/value pair regardless of whether the key is present.

Parameters
- tagKey: TagKey
  
  The TagKey which will be set.
- tagValue: TagValue
  
  The TagValue to set for the given key.
- Optional tagMetadata: TagMetadata
  
  The TagMetadata associated with this Tag.
Returns void

Generated using TypeDoc