Skip to content
This repository was archived by the owner on Nov 17, 2025. It is now read-only.

Commit 1ed52fd

Browse files
docs: add notes on attribute key descriptor (#155)
Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>
1 parent b125324 commit 1ed52fd

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

src/common/Attributes.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
/**
1818
* Attributes is a map from string to attribute values.
19+
*
20+
* Note: only the own enumerable keys are counted as valid attribute keys.
1921
*/
2022
export interface Attributes {
2123
[attributeKey: string]: AttributeValue | undefined;

src/trace/attributes.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
import { Attributes, AttributeValue } from '../common/Attributes';
1818

1919
/**
20-
* @deprecated please use Attributes
20+
* @deprecated please use {@link Attributes}
2121
*/
2222
export type SpanAttributes = Attributes;
2323

2424
/**
25-
* @deprecated please use AttributeValue
25+
* @deprecated please use {@link AttributeValue}
2626
*/
2727
export type SpanAttributeValue = AttributeValue;

0 commit comments

Comments
 (0)