Skip to content

Commit 7fa017d

Browse files
committed
docs: add missing TSDoc on class fields flagged by require-property-tsdoc
Full-repo fusion-lint sweep after adding the new rule surfaced 13 pre-existing class fields without TSDoc. Documented each.
1 parent 4f33469 commit 7fa017d

13 files changed

Lines changed: 28 additions & 1 deletion

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"@equinor/fusion-framework-cookbook-app-react-router": patch
3+
"@equinor/fusion-framework-module-app": patch
4+
"@equinor/fusion-framework-module-analytics": patch
5+
"@equinor/fusion-framework-module-azure-identity": patch
6+
"@equinor/fusion-framework-module-bookmark": patch
7+
"@equinor/fusion-framework-module-feature-flag": patch
8+
"@equinor/fusion-framework-module-http": patch
9+
"@equinor/fusion-framework-module-services": patch
10+
"@equinor/fusion-query": patch
11+
---
12+
13+
Added missing TSDoc comments on class fields flagged by the new `require-property-tsdoc` fusion-lint rule.

cookbooks/app-react-router/src/api/Api.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,11 @@ interface IHttpProvider {
2121
* Uses React Query for caching and request deduplication
2222
*/
2323
export class Api {
24+
/** Product-related API client. */
2425
readonly product: ProductApi;
26+
/** People-related API client. */
2527
readonly people: PeopleApi;
28+
/** User-related API client. */
2629
readonly user: UserApi;
2730

2831
/**

packages/modules/analytics/src/AnalyticsProvider.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class DisposableSubscription extends Subscription {
2424
super(subscription.unsubscribe);
2525
}
2626

27+
/** TC39 `Disposable` protocol support, delegating to `unsubscribe()`. */
2728
[Symbol.dispose] = () => {
2829
this.unsubscribe();
2930
};

packages/modules/app/src/AppConfigurator.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export class AppConfigurator
5959
extends BaseConfigBuilder<AppModuleConfig>
6060
implements IAppConfigurator
6161
{
62+
/** Default cache expiration time, in milliseconds, for the app service client. */
6263
defaultExpireTime = 1 * 60 * 1000;
6364

6465
/**

packages/modules/app/src/app/App.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,7 @@ export class App<
977977
return operator(this.getAppModule(!allow_cache));
978978
}
979979

980+
/** Releases resources held by this app instance. */
980981
public dispose: VoidFunction;
981982
}
982983

packages/modules/azure-identity/src/NoCredentialError.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66
* failure without relying on brittle string matching.
77
*/
88
export class NoCredentialError extends Error {
9+
/** Discriminant used to identify this error type. */
910
override readonly name = 'NoCredentialError';
1011
}

packages/modules/bookmark/src/BookmarkModuleConfigurator.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ const parseInitialBookmarkConfigConfig = (initial?: unknown): BookmarkModuleConf
4343
*/
4444
export class BookmarkModuleConfigurator extends BaseConfigBuilder<BookmarkModuleConfig> {
4545
#log?: ILogger;
46-
defaultExpireTime = 1 * 60 * 1000; // Default expiration time for bookmarks
46+
/** Default expiration time, in milliseconds, for bookmarks. */
47+
defaultExpireTime = 1 * 60 * 1000;
4748

4849
/**
4950
* Constructs a new `BookmarkModuleConfigurator`.

packages/modules/feature-flag/src/FeatureFlag.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export class FeatureFlag<T = unknown> implements IFeatureFlag {
7878
return !!this._options.readonly;
7979
}
8080

81+
/** Marks this instance as immerable so `immer` can produce structural clones. */
8182
[immerable] = true;
8283

8384
/**

packages/modules/http/src/configurator.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ export interface IHttpClientConfigurator<TClient extends IHttpClient = IHttpClie
153153
export class HttpClientConfigurator<TClient extends IHttpClient>
154154
implements IHttpClientConfigurator<TClient>
155155
{
156+
/** Named client configurations keyed by client name. */
156157
protected _clients: Record<string, HttpClientOptions<TClient>> = {};
157158

158159
/**

packages/modules/http/src/errors/HttpJsonResponseError.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ export class HttpJsonResponseError<
1212
TResponse = Response,
1313
> extends HttpResponseError<TResponse> {
1414
static Name = 'HttpJsonResponseError';
15+
/** The parsed JSON data associated with the error response, if any. */
1516
public readonly data?: TType;
1617

1718
/**

0 commit comments

Comments
 (0)