Skip to content

Commit 670f0f5

Browse files
committed
naming and comment changes
1 parent 7b56c04 commit 670f0f5

3 files changed

Lines changed: 26 additions & 21 deletions

File tree

packages/js/uri-resolvers/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,8 @@ export class WrapperCache implements IWrapperCache
257257
```ts
258258
/**
259259
* An IUriResolver implementation that caches wrappers once they are resolved.
260-
* It does not cache URIs and packages.
260+
* As it is a wrapper cache resolver, URI and package caching is outside of the scope for this resolver
261+
* and can be achieved through other resolvers if necessary.
261262
* The WrapperCacheResolver wraps an IUriResolver implementation and delegates resolution to it.
262263
* */
263264
export class WrapperCacheResolver<TError>
@@ -269,11 +270,11 @@ export class WrapperCacheResolver<TError>
269270
/**
270271
* Creates a WrapperCacheResolver
271272
*
272-
* @param _resolverToCache - a resolver to delegate resolution to
273+
* @param _innerResolver - a resolver to delegate resolution to
273274
* @param _cache - a wrapper cache
274275
* */
275276
constructor(
276-
private _resolverToCache: IUriResolver<TError>,
277+
private _innerResolver: IUriResolver<TError>,
277278
private _cache: IWrapperCache
278279
)
279280
```
@@ -285,14 +286,14 @@ export class WrapperCacheResolver<TError>
285286
/**
286287
* Creates a WrapperCacheResolver from a resolver-like object
287288
*
288-
* @param resolver - a resolver-like item to delegate resolution to
289+
* @param innerResolver - a resolver-like item to delegate resolution to
289290
* @param cache - a wrapper cache
290291
* @param options - control wrapper manifest deserialization
291292
*
292293
* @returns a WrapperCacheResolver
293294
* */
294295
static from<TResolverError = unknown>(
295-
resolver: UriResolverLike,
296+
innerResolver: UriResolverLike,
296297
cache: IWrapperCache
297298
): WrapperCacheResolver<TResolverError>
298299
```
@@ -482,11 +483,11 @@ export class PackageToWrapperResolver<TError>
482483
/**
483484
* Creates a PackageToWrapperResolver
484485
*
485-
* @param _resolver - a resolver to delegate resolution to
486+
* @param _innerResolver - a resolver to delegate resolution to
486487
* @param _options - control wrapper manifest deserialization
487488
* */
488489
constructor(
489-
private _resolver: IUriResolver<TError>,
490+
private _innerResolver: IUriResolver<TError>,
490491
private _options?: {
491492
deserializeManifestOptions?: DeserializeManifestOptions;
492493
}
@@ -500,13 +501,13 @@ export class PackageToWrapperResolver<TError>
500501
/**
501502
* Creates a PackageToWrapperResolver from a resolver-like object
502503
*
503-
* @param resolver - a resolver-like item to delegate resolution to
504+
* @param innerResolver - a resolver-like item to delegate resolution to
504505
* @param options - control wrapper manifest deserialization
505506
*
506507
* @returns a PackageToWrapperResolver
507508
* */
508509
static from<TResolverError = unknown>(
509-
resolver: UriResolverLike,
510+
innerResolver: UriResolverLike,
510511
options?: { deserializeManifestOptions?: DeserializeManifestOptions }
511512
): PackageToWrapperResolver<TResolverError>
512513
```

packages/js/uri-resolvers/src/cache/WrapperCacheResolver.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,30 +23,30 @@ export class WrapperCacheResolver<TError>
2323
/**
2424
* Creates a WrapperCacheResolver
2525
*
26-
* @param _resolverToCache - a resolver to delegate resolution to
26+
* @param _innerResolver - a resolver to delegate resolution to
2727
* @param _cache - a wrapper cache
2828
* */
2929
constructor(
30-
private _resolverToCache: IUriResolver<TError>,
30+
private _innerResolver: IUriResolver<TError>,
3131
private _cache: IWrapperCache
3232
) /* $ */ {}
3333

3434
// $start: WrapperCacheResolver-from
3535
/**
3636
* Creates a WrapperCacheResolver from a resolver-like object
3737
*
38-
* @param resolver - a resolver-like item to delegate resolution to
38+
* @param innerResolver - a resolver-like item to delegate resolution to
3939
* @param cache - a wrapper cache
4040
* @param options - control wrapper manifest deserialization
4141
*
4242
* @returns a WrapperCacheResolver
4343
* */
4444
static from<TResolverError = unknown>(
45-
resolver: UriResolverLike,
45+
innerResolver: UriResolverLike,
4646
cache: IWrapperCache
4747
): WrapperCacheResolver<TResolverError> /* $ */ {
4848
return new WrapperCacheResolver(
49-
UriResolver.from<TResolverError>(resolver),
49+
UriResolver.from<TResolverError>(innerResolver),
5050
cache
5151
);
5252
}
@@ -83,7 +83,7 @@ export class WrapperCacheResolver<TError>
8383
// Resolve uri if not in cache
8484
const subContext = resolutionContext.createSubHistoryContext();
8585

86-
const result = await this._resolverToCache.tryResolveUri(
86+
const result = await this._innerResolver.tryResolveUri(
8787
uri,
8888
client,
8989
subContext

packages/js/uri-resolvers/src/helpers/PackageToWrapperResolver.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ export class PackageToWrapperResolver<TError>
2121
/**
2222
* Creates a PackageToWrapperResolver
2323
*
24-
* @param _resolver - a resolver to delegate resolution to
24+
* @param _innerResolver - a resolver to delegate resolution to
2525
* @param _options - control wrapper manifest deserialization
2626
* */
2727
constructor(
28-
private _resolver: IUriResolver<TError>,
28+
private _innerResolver: IUriResolver<TError>,
2929
private _options?: {
3030
deserializeManifestOptions?: DeserializeManifestOptions;
3131
}
@@ -35,17 +35,17 @@ export class PackageToWrapperResolver<TError>
3535
/**
3636
* Creates a PackageToWrapperResolver from a resolver-like object
3737
*
38-
* @param resolver - a resolver-like item to delegate resolution to
38+
* @param innerResolver - a resolver-like item to delegate resolution to
3939
* @param options - control wrapper manifest deserialization
4040
*
4141
* @returns a PackageToWrapperResolver
4242
* */
4343
static from<TResolverError = unknown>(
44-
resolver: UriResolverLike,
44+
innerResolver: UriResolverLike,
4545
options?: { deserializeManifestOptions?: DeserializeManifestOptions }
4646
): PackageToWrapperResolver<TResolverError> /* $ */ {
4747
return new PackageToWrapperResolver(
48-
UriResolver.from<TResolverError>(resolver),
48+
UriResolver.from<TResolverError>(innerResolver),
4949
options
5050
);
5151
}
@@ -67,7 +67,11 @@ export class PackageToWrapperResolver<TError>
6767
): Promise<Result<UriPackageOrWrapper, TError | Error>> /* $ */ {
6868
const subContext = resolutionContext.createSubHistoryContext();
6969

70-
let result = await this._resolver.tryResolveUri(uri, client, subContext);
70+
let result = await this._innerResolver.tryResolveUri(
71+
uri,
72+
client,
73+
subContext
74+
);
7175

7276
if (result.ok && result.value.type === "package") {
7377
const wrapPackage = result.value.package;

0 commit comments

Comments
 (0)