11
11
// The SDK can be used to parse entry strings, encode and decode module names, and generate filenames for exposed modules and shared packages.
12
12
// It also includes a logger for debugging and environment detection utilities.
13
13
// 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' ;
15
15
16
16
// Parse an entry string into a RemoteEntryInfo object
17
17
parseEntry (' entryString' );
@@ -28,8 +28,8 @@ generateExposeFilename('exposeName', true);
28
28
// Generate a filename for a shared package
29
29
generateShareFilename (' packageName' , true );
30
30
31
- // Create a new logger
32
- const logger = new Logger (' identifier' );
31
+ // Create a logger
32
+ const logger = createLogger (' identifier' );
33
33
34
34
// Check if the current environment is a browser
35
35
isBrowserEnv ();
@@ -46,12 +46,12 @@ generateSnapshotFromManifest(manifest, options);
46
46
47
47
### parseEntry
48
48
49
- - Type: ` parseEntry(str: string, devVerOrUrl?: string) `
49
+ - Type: ` parseEntry(str: string, devVerOrUrl?: string, separator?: string) `
50
50
- Parses a string into a RemoteEntryInfo object.
51
51
52
52
### encodeName
53
53
54
- - Type: ` encodeName(name: string, prefix = '' , withExt = false ) `
54
+ - Type: ` encodeName(name: string, prefix?: string , withExt?: boolean ) `
55
55
- Encodes a name with a prefix and optional extension.
56
56
57
57
### decodeName
@@ -69,10 +69,10 @@ generateSnapshotFromManifest(manifest, options);
69
69
- Type: ` generateShareFilename(pkgName: string, withExt: boolean) `
70
70
- Generates a filename for a shared package.
71
71
72
- ### Logger
72
+ ### createLogger
73
73
74
- - Type: ` new Logger(identifier? : string)`
75
- - Creates a new logger for debugging.
74
+ - Type: ` createLogger(prefix : string)`
75
+ - Creates a logger for debugging.
76
76
77
77
### isBrowserEnv
78
78
@@ -91,7 +91,7 @@ generateSnapshotFromManifest(manifest, options);
91
91
92
92
### generateSnapshotFromManifest
93
93
94
- - Type: ` generateSnapshotFromManifest(manifest: Manifest, options: IOptions = {} ) `
94
+ - Type: ` generateSnapshotFromManifest(manifest: Manifest, options? : IOptions) `
95
95
- Generates a snapshot from a manifest.
96
96
97
97
## Testing
0 commit comments