30 lines
1.5 KiB
Plaintext
30 lines
1.5 KiB
Plaintext
import type { AstroConfig } from '../@types/astro.js';
|
|
import { type Preferences } from './defaults.js';
|
|
type DotKeys<T> = T extends object ? {
|
|
[K in keyof T]: `${Exclude<K, symbol>}${DotKeys<T[K]> extends never ? '' : `.${DotKeys<T[K]>}`}`;
|
|
}[keyof T] : never;
|
|
export type GetDotKey<T extends Record<string | number, any>, K extends string> = K extends `${infer U}.${infer Rest}` ? GetDotKey<T[U], Rest> : T[K];
|
|
export type PreferenceLocation = 'global' | 'project';
|
|
export interface PreferenceOptions {
|
|
location?: PreferenceLocation;
|
|
}
|
|
type DeepPartial<T> = T extends object ? {
|
|
[P in keyof T]?: DeepPartial<T[P]>;
|
|
} : T;
|
|
export type PreferenceKey = DotKeys<Preferences>;
|
|
export interface PreferenceList extends Record<PreferenceLocation, DeepPartial<Preferences>> {
|
|
fromAstroConfig: DeepPartial<Preferences>;
|
|
defaults: Preferences;
|
|
}
|
|
export interface AstroPreferences {
|
|
get<Key extends PreferenceKey>(key: Key, opts?: PreferenceOptions): Promise<GetDotKey<Preferences, Key>>;
|
|
set<Key extends PreferenceKey>(key: Key, value: GetDotKey<Preferences, Key>, opts?: PreferenceOptions): Promise<void>;
|
|
getAll(): Promise<Preferences>;
|
|
list(opts?: PreferenceOptions): Promise<PreferenceList>;
|
|
}
|
|
export declare function isValidKey(key: string): key is PreferenceKey;
|
|
export declare function coerce(key: string, value: unknown): any;
|
|
export default function createPreferences(config: AstroConfig): AstroPreferences;
|
|
export declare function getGlobalPreferenceDir(): string;
|
|
export {};
|