line_push/node_modules/@nuxt/components/dist/index.d.ts
2022-07-21 03:28:35 +00:00

63 lines
1.6 KiB
TypeScript

import { Module } from '@nuxt/types/config';
interface Component {
pascalName: string;
kebabName: string;
import: string;
asyncImport: string;
export: string;
filePath: string;
shortPath: string;
isAsync?: boolean;
chunkName: string;
/** @deprecated */
global: boolean;
level: number;
prefetch: boolean;
preload: boolean;
}
interface ScanDir {
path: string;
pattern?: string | string[];
ignore?: string[];
prefix?: string;
isAsync?: boolean;
/** @deprecated */
global?: boolean | 'dev';
pathPrefix?: boolean;
level?: number;
prefetch?: boolean;
preload?: boolean;
extendComponent?: (component: Component) => Promise<Component | void> | (Component | void);
}
interface ComponentsDir extends ScanDir {
watch?: boolean;
extensions?: string[];
transpile?: 'auto' | boolean;
}
declare type componentsDirHook = (dirs: ComponentsDir[]) => void | Promise<void>;
declare type componentsExtendHook = (components: (ComponentsDir | ScanDir)[]) => void | Promise<void>;
interface Options {
dirs: (string | ComponentsDir)[];
loader: Boolean;
}
declare module '@nuxt/types/config/index' {
interface NuxtOptions {
components: boolean | Options | Options['dirs'];
}
}
declare module '@nuxt/types/config/hooks' {
interface NuxtOptionsHooks {
'components:dirs'?: componentsDirHook;
'components:extend'?: componentsExtendHook;
components?: {
dirs?: componentsDirHook;
extend?: componentsExtendHook;
};
}
}
declare const componentsModule: Module<Options>;
export { componentsModule as default };