fix(line): use readonly arrays for props as the library does not modi…

…fy them (#2494)
plouc · Mar 5, 2024 · 193a4ce · 193a4ce
1 parent 0ab8f73
commit 193a4ce
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/packages/line/index.d.ts b/packages/line/index.d.ts
@@ -43,12 +43,12 @@ export interface ComputedDatum {
 
 export interface Serie {
     id: string | number
-    data: Datum[]
+    data: readonly Datum[]
     [key: string]: any
 }
 export interface ComputedSerie {
     id: string | number
-    data: ComputedDatum[]
+    data: readonly ComputedDatum[]
     color?: string
     [key: string]: any
 }
@@ -69,8 +69,8 @@ export interface CustomLayerProps extends Omit<LineSvgProps, 'xScale' | 'yScale'
     innerHeight: number
     innerWidth: number
     lineGenerator: D3Line<ComputedDatum['position']>
-    points: Point[]
-    series: ComputedSerie[]
+    points: readonly Point[]
+    series: readonly ComputedSerie[]
     xScale: Scale<unknown, unknown>
     yScale: Scale<unknown, unknown>
 }
@@ -116,7 +116,7 @@ export interface SliceTooltipProps {
         x: number
         y0: number
         y: number
-        points: Point[]
+        points: readonly Point[]
     }
 }
 export type SliceTooltip = React.FunctionComponent<SliceTooltipProps>
@@ -130,14 +130,14 @@ export interface PointSymbolProps {
 }
 
 export interface LineProps {
-    data: Serie[]
+    data: readonly Serie[]
 
     xScale?: ScaleSpec
     xFormat?: ValueFormat<DatumValue>
     yScale?: ScaleSpec
     yFormat?: ValueFormat<DatumValue>
 
-    layers?: Layer[]
+    layers?: readonly Layer[]
 
     margin?: Box
 
@@ -179,7 +179,7 @@ export interface LineProps {
     areaOpacity?: number
     areaBaselineValue?: DatumValue
 
-    markers?: CartesianMarkerProps[]
+    markers?: readonly CartesianMarkerProps[]
 
     isInteractive?: boolean
     onMouseEnter?: PointMouseHandler
@@ -203,7 +203,7 @@ export interface LineProps {
     crosshairType?: CrosshairType
     enableTouchCrosshair?: boolean
 
-    legends?: LegendProps[]
+    legends?: readonly LegendProps[]
 }
 
 export interface LineSvgProps extends LineProps, MotionProps, SvgDefsAndFill<Datum> {
@@ -227,7 +227,7 @@ export type CanvasLayer = LineLayerType | CustomCanvasLayer
 
 export interface LineCanvasProps extends Omit<LineProps, 'layers'> {
     pixelRatio?: number
-    layers?: CanvasLayer[]
+    layers?: readonly CanvasLayer[]
 }
 
 export class LineCanvas extends React.Component<LineCanvasProps & Dimensions> {}