Skip to content

Commit 9c81bb6

Browse files
authored
docs(sdk): update README to new createLogger API (#3194)
1 parent 0898ffe commit 9c81bb6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/sdk/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
// The SDK can be used to parse entry strings, encode and decode module names, and generate filenames for exposed modules and shared packages.
1212
// It also includes a logger for debugging and environment detection utilities.
1313
// Additionally, it provides a function to generate a snapshot from a manifest and environment detection utilities.
14-
import { parseEntry, encodeName, decodeName, generateExposeFilename, generateShareFilename, Logger, isBrowserEnv, isDebugMode, getProcessEnv, generateSnapshotFromManifest } from '@module-federation/sdk';
14+
import { parseEntry, encodeName, decodeName, generateExposeFilename, generateShareFilename, createLogger, isBrowserEnv, isDebugMode, getProcessEnv, generateSnapshotFromManifest } from '@module-federation/sdk';
1515

1616
// Parse an entry string into a RemoteEntryInfo object
1717
parseEntry('entryString');
@@ -28,8 +28,8 @@ generateExposeFilename('exposeName', true);
2828
// Generate a filename for a shared package
2929
generateShareFilename('packageName', true);
3030

31-
// Create a new logger
32-
const logger = new Logger('identifier');
31+
// Create a logger
32+
const logger = createLogger('identifier');
3333

3434
// Check if the current environment is a browser
3535
isBrowserEnv();
@@ -46,12 +46,12 @@ generateSnapshotFromManifest(manifest, options);
4646

4747
### parseEntry
4848

49-
- Type: `parseEntry(str: string, devVerOrUrl?: string)`
49+
- Type: `parseEntry(str: string, devVerOrUrl?: string, separator?: string) `
5050
- Parses a string into a RemoteEntryInfo object.
5151

5252
### encodeName
5353

54-
- Type: `encodeName(name: string, prefix = '', withExt = false)`
54+
- Type: `encodeName(name: string, prefix?: string, withExt?: boolean)`
5555
- Encodes a name with a prefix and optional extension.
5656

5757
### decodeName
@@ -69,10 +69,10 @@ generateSnapshotFromManifest(manifest, options);
6969
- Type: `generateShareFilename(pkgName: string, withExt: boolean)`
7070
- Generates a filename for a shared package.
7171

72-
### Logger
72+
### createLogger
7373

74-
- Type: `new Logger(identifier?: string)`
75-
- Creates a new logger for debugging.
74+
- Type: `createLogger(prefix: string)`
75+
- Creates a logger for debugging.
7676

7777
### isBrowserEnv
7878

@@ -91,7 +91,7 @@ generateSnapshotFromManifest(manifest, options);
9191

9292
### generateSnapshotFromManifest
9393

94-
- Type: `generateSnapshotFromManifest(manifest: Manifest, options: IOptions = {})`
94+
- Type: `generateSnapshotFromManifest(manifest: Manifest, options?: IOptions)`
9595
- Generates a snapshot from a manifest.
9696

9797
## Testing

0 commit comments

Comments
 (0)