Skip to content

Commit

Permalink
docs finished
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Sep 29, 2024
1 parent 9d74599 commit 80c25bb
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/count.ts
Original file line number Diff line number Diff line change
@@ -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 {
/**
Expand Down
4 changes: 2 additions & 2 deletions src/event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export interface IEventOptions<T> {
* ```
*
* @param ctx
* `ctx`: [[ISubContext]] - Subscription Context.
* `ctx`: {@link ISubContext} - Subscription Context.
*/
onSubscribe?: (ctx: ISubContext<T>) => void;

Expand Down Expand Up @@ -542,7 +542,7 @@ export class SubEvent<T = unknown> {
}

/**
* Creates unsubscribe callback function for the [[Subscription]] class.
* Creates unsubscribe callback function for the {@link Subscription} class.
* @hidden
*
* @param sub
Expand Down
1 change: 0 additions & 1 deletion src/sub.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/**
* @class
* Represents an event subscription, and a safe way to cancel it.
*
* @see {@link cancel}
Expand Down
2 changes: 1 addition & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit 80c25bb

Please sign in to comment.