@isdk/ai-tool 0.5.7 → 0.6.0

package/docs/classes/ConfigFile.md

@@ -6,41 +6,34 @@
 
 # Class: ConfigFile
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:28
+Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:30
 
-## Constructors
-
-### new ConfigFile()
-
-> **new ConfigFile**(`aOptions`?): [`ConfigFile`](ConfigFile.md)
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:42
+Represents a configuration file utility class that provides methods to load and save configuration files.
+It supports multiple file formats such as YAML, JSON, etc., by registering corresponding parsers and stringifiers.
 
-#### Parameters
+## Example
 
-##### aOptions?
+```typescript
+// Register a custom file type handler
+ConfigFile.register('.custom', (content) => {
+  return { data: content.toUpperCase() }; // Example parser
+}, (obj) => {
+  return obj.data.toLowerCase(); // Example stringifier
+});
 
-`IConfigOptions`
+// Save a configuration file
+ConfigFile.saveSync('config.custom', { key: 'value' });
 
-#### Returns
+// Load a configuration file
+const config = ConfigFile.loadSync('config.custom');
+console.log(config); // Output: { key: 'value' }
+```
 
-[`ConfigFile`](ConfigFile.md)
+## Constructors
 
 ### new ConfigFile()
 
-> **new ConfigFile**(`aPath`, `aOptions`?): [`ConfigFile`](ConfigFile.md)
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:43
-
-#### Parameters
-
-##### aPath
-
-`string`
-
-##### aOptions?
-
-`IConfigOptions`
+> **new ConfigFile**(): [`ConfigFile`](ConfigFile.md)
 
 #### Returns
 
@@ -48,306 +41,129 @@ Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config
 
 ## Properties
 
-### configurators
+### stringifys
 
-> **configurators**: `IConfigurator`
+> `static` **stringifys**: `Record`\<`string`, `StringifyFunc`\>
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:37
-
-***
+Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:34
 
-### fs
-
-> **fs**: `IFileSystem`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:38
-
-***
-
-### path
-
-> **path**: `any`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:39
-
-***
-
-### readFile
-
-> **readFile**: `any`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:40
+A record of registered stringify functions for different file extensions.
 
 ## Methods
 
-### load()
-
-#### Call Signature
-
-> **load**(`aPath`, `done`): `void`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:44
-
-##### Parameters
-
-###### aPath
-
-`string`
-
-###### done
-
-`ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-#### Call Signature
-
-> **load**(`done`): `void`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:45
-
-##### Parameters
-
-###### done
-
-`ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-#### Call Signature
-
-> **load**(`aPath`, `aOptions`, `done`): `void`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:46
-
-##### Parameters
-
-###### aPath
-
-`string`
-
-###### aOptions
-
-`IConfigOptions`
-
-###### done
-
-`ConfigCallBackFn`
-
-##### Returns
-
-`void`
-
-#### Call Signature
-
-> **load**(`aPath`, `aOptions`?): `Promise`\<`any`\>
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:47
-
-##### Parameters
-
-###### aPath
-
-`string`
-
-###### aOptions?
-
-`IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
-
-#### Call Signature
-
-> **load**(`aOptions`?): `Promise`\<`any`\>
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:48
-
-##### Parameters
-
-###### aOptions?
-
-`IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
-
-***
-
 ### loadSync()
 
-#### Call Signature
+> `static` **loadSync**(`filename`, `options`?): `any`
 
-> **loadSync**(`aPath`, `aOptions`?): `any`
+Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:61
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:49
+Loads a configuration file based on the provided filename and options.
 
-##### Parameters
+#### Parameters
 
-###### aPath
+##### filename
 
 `string`
 
-###### aOptions?
-
-`IConfigOptions`
+The path to the configuration file.
 
-##### Returns
-
-`any`
+##### options?
 
-#### Call Signature
+`LoadConfigFileOptions`
 
-> **loadSync**(`aOptions`?): `any`
+Additional options for loading the configuration file.
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:50
-
-##### Parameters
-
-###### aOptions?
-
-`IConfigOptions`
-
-##### Returns
+#### Returns
 
 `any`
 
-***
-
-### load()
-
-#### Call Signature
-
-> `static` **load**(`aPath`, `aOptions`?): `Promise`\<`any`\>
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:32
-
-##### Parameters
-
-###### aPath
-
-`string`
-
-###### aOptions?
-
-`IConfigOptions`
-
-##### Returns
-
-`Promise`\<`any`\>
+The parsed configuration object.
 
-#### Call Signature
+#### Example
 
-> `static` **load**(`aPath`, `aOptions`, `done`): `void` \| `Promise`\<`any`\>
+```typescript
+const config = ConfigFile.loadSync('config.yaml');
+console.log(config); // Output: { key: 'value' }
+```
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:33
+***
 
-##### Parameters
+### register()
 
-###### aPath
+> `static` **register**(`extname`, `parser`, `stringify`): `void`
 
-`string`
+Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:47
 
-###### aOptions
+Registers a parser and stringifier for specific file extensions.
 
-`IConfigOptions`
-
-###### done
+#### Parameters
 
-`true` | `ConfigCallBackFn`
+##### extname
 
-##### Returns
+The file extension(s) to register the parser and stringifier for.
 
-`void` \| `Promise`\<`any`\>
+`string` | `string`[]
 
-#### Call Signature
+##### parser
 
-> `static` **load**(`aPath`, `done`): `void` \| `Promise`\<`any`\>
+(`content`) => `any`
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:34
+A function that parses the file content into an object.
 
-##### Parameters
+##### stringify
 
-###### aPath
+`StringifyFunc`
 
-`string`
+A function that converts an object back into file content.
 
-###### done
+#### Returns
 
-`true` | `ConfigCallBackFn`
+`void`
 
-##### Returns
+#### Example
 
-`void` \| `Promise`\<`any`\>
+```typescript
+ConfigFile.register(['.json'], JSON.parse, (obj) => JSON.stringify(obj, null, 2));
+```
 
 ***
 
-### loadSync()
+### saveSync()
+
+> `static` **saveSync**(`filename`, `config`, `options`?): `string`
 
-> `static` **loadSync**(`aPath`, `aOptions`?): `any`
+Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:75
 
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:35
+Saves a configuration object to a file with the specified filename and options.
 
 #### Parameters
 
-##### aPath
+##### filename
 
 `string`
 
-##### aOptions?
+The path where the configuration file should be saved.
 
-`IConfigOptions`
-
-#### Returns
+##### config
 
 `any`
 
-***
-
-### register()
-
-> `static` **register**(`aExts`, `aProcess`, `aConfigurators`?): `any`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:29
+The configuration object to save.
 
-#### Parameters
-
-##### aExts
-
-`string` | `string`[]
-
-##### aProcess
+##### options?
 
-`ConfigAsyncProcessFn`
+`LoadConfigFileOptions`
 
-##### aConfigurators?
-
-`IConfigurator`
+Additional options for saving the configuration file.
 
 #### Returns
 
-`any`
-
-***
-
-### setFileSystem()
-
-> `static` **setFileSystem**(`aFileSystem`): `any`
-
-Defined in: node\_modules/.pnpm/load-config-file@2.0.0/node\_modules/load-config-file/lib/index.d.ts:30
-
-#### Parameters
-
-##### aFileSystem
+`string`
 
-`IFileSystem`
+The final filename where the configuration was saved.
 
-#### Returns
+#### Example
 
-`any`
+```typescript
+ConfigFile.saveSync('config.json', { key: 'value' });
+```