Skip to content

Commit 66ceb48

Browse files
committed
readme updates
1 parent d310352 commit 66ceb48

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

packages/js/client-config-builder/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,12 +223,12 @@ export interface ClientConfig<TUri extends Uri | string = Uri | string> {
223223
/**
224224
* Instantiate a ClientConfigBuilder
225225
*
226-
* @param wrapperCache?: a wrapper cache to be used in place of the default wrapper cache
227-
* @param resolver?: a uri resolver to be used in place of any added redirects, wrappers, packages, and resolvers when building a CoreClientConfig
226+
* @param _wrapperCache?: a wrapper cache to be used in place of the default wrapper cache
227+
* @param _resolver?: a uri resolver to be used in place of any added redirects, wrappers, packages, and resolvers when building a CoreClientConfig
228228
*/
229229
constructor(
230-
private readonly wrapperCache?: IWrapperCache,
231-
private readonly resolver?: IUriResolver<unknown>
230+
private readonly _wrapperCache?: IWrapperCache,
231+
private readonly _resolver?: IUriResolver<unknown>
232232
)
233233
```
234234

packages/js/core/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -558,10 +558,10 @@ export interface Wrapper extends Invocable {
558558
/** Contains either a Uri, a manifest, or neither */
559559
export interface MaybeUriOrManifest {
560560
/** wrap URI */
561-
uri?: string;
561+
uri?: string | null;
562562

563563
/** Serialized wrap manifest */
564-
manifest?: Uint8Array;
564+
manifest?: Uint8Array | null;
565565
}
566566
```
567567
@@ -600,7 +600,7 @@ export interface MaybeUriOrManifest {
600600
invoker: Invoker,
601601
wrapper: Uri,
602602
path: string
603-
): Promise<Result<Uint8Array | undefined, WrapError>>
603+
): Promise<Result<Uint8Array | null, WrapError>>
604604
```
605605
606606
## Uri Resolution
@@ -730,6 +730,8 @@ export type UriPackageOrWrapper = UriValue | UriPackageValue | UriWrapperValue;
730730
731731
```ts
732732
/** An implementation of the IUriResolutionContext interface */
733+
// $start: UriResolutionContext
734+
/** An implementation of the IUriResolutionContext interface */
733735
export class UriResolutionContext implements IUriResolutionContext {
734736
```
735737

0 commit comments

Comments
 (0)