add missing ts docs

.size-limit.js

@@ -8,31 +8,31 @@ export default [
 	{
 		name: 'ESM',
 		path: 'dist/lightweight-charts.production.mjs',
-		limit: '45.00 KB',
+		limit: '44.50 KB',
 		import: '*',
 		ignore: ['fancy-canvas'],
 		brotli: true,
 	},
 	{
 		name: 'ESM createChart',
 		path: 'dist/lightweight-charts.production.mjs',
-		limit: '45.00 KB',
+		limit: '41.30 KB',
 		import: '{ createChart }',
 		ignore: ['fancy-canvas'],
 		brotli: true,
 	},
 	{
 		name: 'ESM createChartEx',
 		path: 'dist/lightweight-charts.production.mjs',
-		limit: '45.00 KB',
+		limit: '40.00 KB',
 		import: '{ createChartEx }',
 		ignore: ['fancy-canvas'],
 		brotli: true,
 	},
 	{
 		name: 'ESM Standalone',
 		path: 'dist/lightweight-charts.standalone.production.mjs',
-		limit: '50.00 KB',
+		limit: '45.90 KB',
 		import: '*',
 		brotli: true,
 	},
@@ -63,7 +63,7 @@ export default [
 		path: 'dist/lightweight-charts.production.mjs',
 		import: '{ createSeriesMarkersPrimitive }',
 		ignore: ['fancy-canvas'],
-		limit: '3.00 KB',
+		limit: '3.90 KB',
 		brotli: true,
 	},
 ];

src/plugins/series-markers/primitive.ts

@@ -12,24 +12,12 @@ import { Logical, TimePointIndex } from '../../model/time-data';
 import { UpdateType } from '../../views/pane/iupdatable-pane-view';
 
 import { SeriesMarkersPaneView } from './pane-view';
-import { InternalSeriesMarker, SeriesMarkerPosition, SeriesMarkerShape } from './types';
+import { InternalSeriesMarker, MarkerPositions, SeriesMarker } from './types';
 import {
 	calculateAdjustedMargin,
 	calculateShapeHeight,
 	shapeMargin as calculateShapeMargin,
 } from './utils';
-interface SeriesMarker<TimeType> {
-	time: TimeType;
-	position: SeriesMarkerPosition;
-	shape: SeriesMarkerShape;
-	color: string;
-	id?: string;
-	text?: string;
-	size?: number;
-	originalTime?: TimeType;
-}
-
-type MarkerPositions = Record<SeriesMarkerPosition, boolean>;
 
 class SeriesMarkersPrimitive<HorzScaleItem> implements ISeriesPrimitive<HorzScaleItem> {
 	private _attached: SeriesAttachedParameter<HorzScaleItem> | null = null;
@@ -206,6 +194,12 @@ class SeriesMarkersPrimitive<HorzScaleItem> implements ISeriesPrimitive<HorzScal
 /**
  * A function to create a series markers primitive.
  *
+ * @param series - The series to which the primitive will be attached.
+ *
+ * @param chart - The chart instance.
+ *
+ * @param markers - An array of markers to be displayed on the series.
+ *
  * @example
  * ```js
  * import { createSeriesMarkersPrimitive } from 'lightweight-charts';

src/plugins/series-markers/types.ts

@@ -51,6 +51,8 @@ export interface SeriesMarker<TimeType = Time> {
 	originalTime: unknown;
 }
 
+export type MarkerPositions = Record<SeriesMarkerPosition, boolean>;
+
 export interface InternalSeriesMarker<TimeType> extends SeriesMarker<TimeType> {
 	internalId: number;
 }