Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(component-meta): update demo #3994

Merged
merged 1 commit into from Mar 5, 2024
Merged

doc(component-meta): update demo #3994

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/component-meta/README.md
View file
Open in desktop
Expand Up @@ -4,14 +4,14 @@

## Guide 📗

First of all, you need to create a component meta checker using `createComponentMetaChecker`:
First of all, you need to create a component meta checker using `createChecker`:

```ts
import * as url from 'url'
import path from 'path'

import type { MetaCheckerOptions } from 'vue-component-meta'
import { createComponentMetaChecker } from 'vue-component-meta'
import { createChecker } from 'vue-component-meta'

const __dirname = url.fileURLToPath(new URL('.', import.meta.url))

Expand All @@ -21,7 +21,7 @@ const checkerOptions: MetaCheckerOptions = {
printer: { newLine: 1 },
}

const tsconfigChecker = createComponentMetaChecker(
const tsconfigChecker = createChecker(
// Write your tsconfig path
path.join(__dirname, 'path-to-tsconfig'),
checkerOptions,
Expand All @@ -40,7 +40,7 @@ const componentPath = path.join(__dirname, 'path-to-component');
const meta = checker.getComponentMeta(componentPath);
```

This meta contains really useful stuff like component props, slots, events and more. You can refer to its [type definition](https://github.com/vuejs/language-tools/blob/master/packages/component-meta/src/types.ts) for more details.
This meta contains really useful stuff like component props, slots, events and more. You can refer to its [type definition](https://github.com/vuejs/language-tools/blob/master/packages/component-meta/lib/types.ts) for more details.

### Extracting prop meta

Expand Down