+
diff --git a/docs/functions/Function_Configuration.readFile.html b/docs/functions/Function_Configuration.readFile.html
index d83924f..82433e0 100644
--- a/docs/functions/Function_Configuration.readFile.html
+++ b/docs/functions/Function_Configuration.readFile.html
@@ -1,4 +1,4 @@
-
Function resolve
- resolve(...paths): string
The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
+resolve | @playform/format - v0.0.8 +Function resolve
- resolve(...paths): string
The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
Starting from leftmost {from} parameter, resolves {to} to an absolute path.
If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.
Parameters
Rest...paths: string[]A sequence of paths or path segments.
-
Returns string
Returns string
Function Merge
- Merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>> Type Parameters
Parameters
Rest...objects: Ts
Returns DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>
Function Merge
- Merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>> Type Parameters
Parameters
Rest...objects: Ts
Returns DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>
Function integration
- integration(Option): AstroIntegration
Parameters
- Option: Interface
Returns AstroIntegration
Function integration
- integration(Option?): AstroIntegration
Parameters
OptionalOption: Interface
Returns AstroIntegration
Function merge
- merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>> Type Parameters
Parameters
Rest...objects: Ts
Returns DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>
Function merge
- merge<Ts>(...objects): DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>> Type Parameters
Parameters
Rest...objects: Ts
Returns DeepMergeHKT<Ts, Readonly<{
DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
DeepMergeOthersURI: "DeepMergeLeafURI";
DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
}>, Readonly<{
key: PropertyKey;
parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>
@playform/format - v0.0.7
 | Related — | ||
   |   🗜️ Compress — |    |   🦔 Inline — |
@playform/format - v0.0.8
 | Related — | ||
| | 🗜️ Compress — | | 🦔 Inline — |
🗻 Format —
This Astro integration brings Biome tools to your Astro
project.
Changelog
See CHANGELOG.md for a history of changes to this integration.
Interface Interface
- Interface(Option): AstroIntegration
Parameters
- Option: Interface
Returns AstroIntegration
Interface Interface
- Interface(Option?): AstroIntegration
Parameters
OptionalOption: Interface
Returns AstroIntegration
Interface Interface
interface Interface {
Action?: boolean | Interface;
Biome?: boolean | Type;
Cache?: boolean | Interface;
Exclude?:
| boolean
| Type
| Type[]
| Set<Type>;
File?: string | boolean | string[];
Logger?: boolean | Type;
Path?:
| boolean
| Type
| Type[]
| Set<Type>;
}
Action?: boolean | Interface;
Biome?: boolean | Type;
Cache?: boolean | Interface;
Exclude?:
| boolean
| Type
| Type[]
| Set<Type>;
File?: string | boolean | string[];
Logger?: boolean | Type;
Path?:
| boolean
| Type
| Type[]
| Set<Type>;
}
Hierarchy
- default
- Interface
Index
Properties
Action?
+Interface | @playform/format - v0.0.8
Interface Interface
interface Interface {
Action?: boolean | Interface;
Biome?: boolean | Type;
Cache?: boolean | Interface;
Exclude?:
| boolean
| Type
| Type[]
| Set<Type>;
File?: string | boolean | string[];
Logger?: boolean | Type;
Path?:
| boolean
| Type
| Type[]
| Set<Type>;
}
Action?: boolean | Interface;
Biome?: boolean | Type;
Cache?: boolean | Interface;
Exclude?:
| boolean
| Type
| Type[]
| Set<Type>;
File?: string | boolean | string[];
Logger?: boolean | Type;
Path?:
| boolean
| Type
| Type[]
| Set<Type>;
}
Hierarchy
- default
- Interface
Properties
OptionalAction
Action?: boolean | Interface
Action pipe configuration.
-OptionalBiome
OptionalCache
Cache?: boolean | Interface
Configuration for the target cache.
-OptionalBiome
OptionalCache
Cache?: boolean | Interface
Configuration for the target cache.
+OptionalExclude
Criteria for excluding files.
+OptionalFile
File?: string | boolean | string[]
File patterns to be matched.
+OptionalLogger
Logger?: boolean | Type
Debugging level.
+OptionalPath
Configuration for the target path(s).
+@playform/format - v0.0.8
Index
Modules
Module Configuration
Index
Interfaces
Module Configuration
Index
Interfaces
Module Function/Configuration
Index
Functions
configuration
+Function/Configuration | @playform/format - v0.0.8
Module Function/Configuration
Index
Functions
Module Function/Integration
Index
Variables
Default
+Function/Integration | @playform/format - v0.0.8
Module Function/Integration
Index
Variables
Functions
Module Interface/Integration
Index
Interfaces
Module Interface/Integration
Index
Interfaces
Module Interface/Option
Index
Interfaces
Module Interface/Option
Index
Interfaces
Module Merge
Index
Functions
merge
-
Module Merge
Index
Functions
merge
+
Module Type/Biome
Index
Type Aliases
Type
-
Module Type/Biome
Index
Type Aliases
Type
+
Module Variable/Biome
Index
Variables
biome
-
Module Variable/Biome
Index
Variables
biome
+
Module Variable/Option
Index
Variables
option
-
Module Variable/Option
Index
Variables
option
+
Type Alias Type
Type Alias Type
Variable Default
Default: {
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Variable Default
Default: {
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Variable biome
biome: any
Variable biome
biome: any
Variable option
option: {
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Variable option
option: {
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Action: {
Accomplished: ((On: Interface) => Promise<string>);
Changed: ((Plan: Interface) => Promise<Interface>);
Failed: ((On: Interface) => Promise<string>);
Fulfilled: ((__namedParameters: Interface) => Promise<string | false>);
Passed: ((On: Interface) => Promise<true>);
Read: ((__namedParameters: Interface) => Promise<string>);
Wrote: ((__namedParameters: Interface) => Promise<Type>);
};
Biome: unknown;
Cache: {
Folder: string;
Search: string;
};
Exclude: false;
File: string;
Logger: 2;
Path: string;
}
Asynchronously reads the entire contents of a file.
+- Preparing search index...
- The search index is not available
@playform/format - v0.0.8Function readFile
Asynchronously reads the entire contents of a file.
If no encoding is specified (using
options.encoding), the data is returned as aBufferobject. Otherwise, the data will be a string.If
@@ -21,8 +21,8 @@optionsis a string, then it specifies the encoding.Any specified
FileHandlehas to support reading.Parameters
filename or
FileHandleOptionaloptions: null | {encoding?: null;
flag?: OpenMode;
} & Abortable
Returns Promise<Buffer>
Fulfills with the contents of the file.
-Since
v10.0.0
-Asynchronously reads the entire contents of a file.
+Since
v10.0.0
+Asynchronously reads the entire contents of a file.
Parameters
A path to a file. If a URL is provided, it must use the
file:protocol. If aFileHandleis provided, the underlying file will not be closed automatically.encoding: BufferEncoding;
flag?: OpenMode | undefined;
} & Abortable | BufferEncoding
An object that may contain an optional flag. @@ -32,4 +32,4 @@ If a
FileHandleis provided, the underlying file will not be closed automatically.Optionaloptions: null | BufferEncoding | ObjectEncodingOptions & Abortable & {flag?: OpenMode | undefined;
}
An object that may contain an optional flag. If a flag is not provided, it defaults to
-'r'.Returns Promise<string | Buffer>
Settings