From 80c25bb2c0a391746d9dea8be341fd1253b85f24 Mon Sep 17 00:00:00 2001 From: Vitaly Tomilov Date: Sun, 29 Sep 2024 18:24:41 +0100 Subject: [PATCH] docs finished --- package.json | 4 ++-- src/count.ts | 2 +- src/event.ts | 4 ++-- src/sub.ts | 1 - typedoc.json | 2 +- 5 files changed, 6 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index 1d11506..edd40d9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sub-events", - "version": "1.9.0", + "version": "1.9.1", "description": "Lightweight, strongly-typed events, with monitored subscriptions.", "main": "dist/src/index.js", "types": "dist/src/index.d.ts", @@ -28,7 +28,7 @@ }, "license": "MIT", "engines": { - "node": ">=10.0.0" + "node": ">=14.0.0" }, "bugs": { "url": "https://github.com/vitaly-t/sub-events/issues" diff --git a/src/count.ts b/src/count.ts index efda500..4722e58 100644 --- a/src/count.ts +++ b/src/count.ts @@ -1,7 +1,7 @@ import {IEmitOptions, IEventOptions, ISubscriber, SubEvent} from './event'; /** - * Represents a change in the number of subscriptions, as used with [[onCount]] event. + * Represents a change in the number of subscriptions, as used with {@link SubEventCount.onCount} event. */ export interface ISubCountChange { /** diff --git a/src/event.ts b/src/event.ts index e19a9b3..73f722e 100644 --- a/src/event.ts +++ b/src/event.ts @@ -113,7 +113,7 @@ export interface IEventOptions { * ``` * * @param ctx - * `ctx`: [[ISubContext]] - Subscription Context. + * `ctx`: {@link ISubContext} - Subscription Context. */ onSubscribe?: (ctx: ISubContext) => void; @@ -542,7 +542,7 @@ export class SubEvent { } /** - * Creates unsubscribe callback function for the [[Subscription]] class. + * Creates unsubscribe callback function for the {@link Subscription} class. * @hidden * * @param sub diff --git a/src/sub.ts b/src/sub.ts index a909906..8e5ba05 100644 --- a/src/sub.ts +++ b/src/sub.ts @@ -1,5 +1,4 @@ /** - * @class * Represents an event subscription, and a safe way to cancel it. * * @see {@link cancel} diff --git a/typedoc.json b/typedoc.json index 822f56f..8080510 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "$schema": "https://typedoc.org/schema.json", - "name": "SUB-EVENTS v1.9", + "name": "SUB-EVENTS v1.9.1", "out": "./docs", "excludeExternals": true, "excludePrivate": true,