Skip to content

⬅️ Back to Table of Contents

📄 metadata/types

📊 Analysis Summary

Metric Count
📐 Interfaces 6

📚 Table of Contents

🛠️ File Location:

📂 packages/metadata/types.ts

Interfaces

PackageManifest

Interface Code 
export interface PackageManifest {
  name: string
  display: string
  addon?: boolean
  author?: string
  description?: string
  external?: string[]
  globals?: Record<string, string>
  manualImport?: boolean
  deprecated?: boolean
  submodules?: boolean
  build?: boolean
  iife?: boolean
  mjs?: boolean
  dts?: boolean
  target?: string
  utils?: boolean
  copy?: string[]
  manualEntryPoints?: true
}

Properties

Name Type Optional Description
name string ✗ not shown
display string ✗ not shown
addon boolean ✓ not shown
author string ✓ not shown
description string ✓ not shown
external string[] ✓ not shown
globals Record<string, string> ✓ not shown
manualImport boolean ✓ not shown
deprecated boolean ✓ not shown
submodules boolean ✓ not shown
build boolean ✓ not shown
iife boolean ✓ not shown
mjs boolean ✓ not shown
dts boolean ✓ not shown
target string ✓ not shown
utils boolean ✓ not shown
copy string[] ✓ not shown
manualEntryPoints true ✓ not shown

VueUseFunction

Interface Code 
export interface VueUseFunction {
  name: string
  package: string
  importPath?: string
  lastUpdated?: number
  category?: string
  description?: string
  docs?: string
  deprecated?: boolean
  internal?: boolean
  component?: boolean
  directive?: boolean
  external?: string
  alias?: string[]
  related?: string[]
  variants?: string[]
  utils?: string[]
}

Properties

Name Type Optional Description
name string ✗ not shown
package string ✗ not shown
importPath string ✓ not shown
lastUpdated number ✓ not shown
category string ✓ not shown
description string ✓ not shown
docs string ✓ not shown
deprecated boolean ✓ not shown
internal boolean ✓ not shown
component boolean ✓ not shown
directive boolean ✓ not shown
external string ✓ not shown
alias string[] ✓ not shown
related string[] ✓ not shown
variants string[] ✓ not shown
utils string[] ✓ not shown

VueUsePackage

Interface Code 
export interface VueUsePackage extends PackageManifest {
  dir: string
  docs?: string
}

Properties

Name Type Optional Description
dir string ✗ not shown
docs string ✓ not shown

PackageIndexes

Interface Code 
export interface PackageIndexes {
  packages: Record<string, VueUsePackage>
  categories: string[]
  functions: VueUseFunction[]
}

Properties

Name Type Optional Description
packages Record<string, VueUsePackage> ✗ not shown
categories string[] ✗ not shown
functions VueUseFunction[] ✗ not shown

CommitInfo

Interface Code 
export interface CommitInfo {
  functions: string[]
  version?: string
  hash: string
  date: string
  message: string
  refs?: string
  body?: string
  author_name: string
  author_email: string
}

Properties

Name Type Optional Description
functions string[] ✗ not shown
version string ✓ not shown
hash string ✗ not shown
date string ✗ not shown
message string ✗ not shown
refs string ✓ not shown
body string ✓ not shown
author_name string ✗ not shown
author_email string ✗ not shown

ContributorInfo

Interface Code 
export interface ContributorInfo {
  name: string
  count: number
  hash: string
}

Properties

Name Type Optional Description
name string ✗ not shown
count number ✗ not shown
hash string ✗ not shown

Generated by Syntax Scribe