⬅️ Back to Table of Contents

📄 types.ts

📊 Analysis Summary

Metric	Count
📐 Interfaces	6

📚 Table of Contents

• Interfaces

🛠️ 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[]
}

Properties

Name	Type	Optional	Description
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[]	✓

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[]
}

Properties

Name	Type	Optional	Description
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[]	✓

VueUsePackage

Interface Code

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

Properties

Name	Type	Optional	Description
dir	string	✗
docs	string	✓

PackageIndexes

Interface Code

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

Properties

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

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[]	✗
version	string	✓
hash	string	✗
date	string	✗
message	string	✗
refs	string	✓
body	string	✓
author_name	string	✗
author_email	string	✗

ContributorInfo

Interface Code

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

Properties

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

---