vue-is-defined 1.0.0

package/README.md

@@ -0,0 +1,42 @@
+<p align="center">
+  <img src="logo.svg" alt="vue-is-defined" width="180" />
+</p>
+
+<h1 align="center">vue-is-defined</h1>
+
+<p align="center">A Vue 3 composition API type guard utility that checks if a ref's value is defined (not null or undefined), with proper TypeScript type narrowing for safe property access.</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/vue-is-defined"><img src="https://img.shields.io/npm/v/vue-is-defined.svg" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/vue-is-defined"><img src="https://img.shields.io/npm/dm/vue-is-defined.svg" alt="npm downloads" /></a>
+  <a href="https://github.com/vuefrag/vue-is-defined/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vue-is-defined.svg" alt="license" /></a>
+</p>
+
+> Extracted from [VueUse](https://vueuse.org/) for standalone use.
+
+## Installation
+
+```bash
+npm install vue-is-defined
+```
+
+## Usage
+
+```ts
+import { isDefined } from 'vue-is-defined';
+```
+
+Non-nullish checking type guard for Ref.
+
+```ts
+import { isDefined } from 'vue-is-defined'
+
+const example = ref(Math.random() ? 'example' : undefined) // Ref<string | undefined>
+
+if (isDefined(example))
+  example // Ref<string>
+```
+
+## License
+
+MIT

package/banner.svg

@@ -0,0 +1,52 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1280 640" width="1280" height="640">
+  <defs>
+    <linearGradient id="banner-bg" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#2c3e50;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#1a252f;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+
+  <!-- Background -->
+  <rect width="1280" height="640" fill="url(#banner-bg)"/>
+
+  <!-- Decorative elements -->
+  <circle cx="1200" cy="100" r="300" fill="#3498db" opacity="0.05"/>
+  <circle cx="80" cy="540" r="200" fill="#3498db" opacity="0.05"/>
+
+  <!-- Top accent bar -->
+  <rect x="0" y="0" width="1280" height="8" fill="#3498db"/>
+
+  <!-- VueFrag badge -->
+  <g transform="translate(80, 80)">
+    <rect width="140" height="50" rx="8" fill="#3498db"/>
+    <text x="70" y="33" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="22" font-weight="700" fill="white">VueFrag</text>
+  </g>
+
+  <!-- Package name -->
+  <text x="80" y="280" font-family="system-ui, -apple-system, sans-serif" font-size="72" font-weight="700" fill="white">vue-is-defined</text>
+
+  <!-- Description -->
+  <text x="80" y="360" font-family="system-ui, -apple-system, sans-serif" font-size="32" fill="#94a3b8">Vue 3 type guard checking if ref value is not null/undefined</text>
+
+  <!-- Install command -->
+  <g transform="translate(80, 420)">
+    <rect width="500" height="60" rx="8" fill="#0f172a"/>
+    <text x="20" y="40" font-family="ui-monospace, monospace" font-size="24" fill="#94a3b8">npm install</text>
+    <text x="200" y="40" font-family="ui-monospace, monospace" font-size="24" fill="#3498db">vue-is-defined</text>
+  </g>
+
+  <!-- Category badge -->
+  <g transform="translate(80, 520)">
+    <rect width="158" height="40" rx="20" fill="#3498db" opacity="0.2"/>
+    <text x="79" y="27" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="18" fill="#3498db">Utilities</text>
+  </g>
+
+  <!-- Vue logo hint -->
+  <g transform="translate(1080, 480)">
+    <polygon points="100,20 140,100 60,100" fill="#3498db" opacity="0.3"/>
+    <polygon points="100,40 125,90 75,90" fill="#3498db" opacity="0.5"/>
+  </g>
+
+  <!-- Bottom text -->
+  <text x="1200" y="600" text-anchor="end" font-family="system-ui, -apple-system, sans-serif" font-size="18" fill="#64748b">Standalone VueUse function</text>
+</svg>

package/dist/index.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+const vue = require('vue');
+
+function isDefined(v) {
+  return vue.unref(v) != null;
+}
+
+exports.isDefined = isDefined;

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import { ComputedRef, Ref } from 'vue';
+
+type IsDefinedReturn = boolean;
+declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: Ref<T>): v is Ref<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
+
+export { isDefined };
+export type { IsDefinedReturn };

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+import { ComputedRef, Ref } from 'vue';
+
+type IsDefinedReturn = boolean;
+declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: Ref<T>): v is Ref<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
+
+export { isDefined };
+export type { IsDefinedReturn };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { ComputedRef, Ref } from 'vue';
+
+type IsDefinedReturn = boolean;
+declare function isDefined<T>(v: ComputedRef<T>): v is ComputedRef<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: Ref<T>): v is Ref<Exclude<T, null | undefined>>;
+declare function isDefined<T>(v: T): v is Exclude<T, null | undefined>;
+
+export { isDefined };
+export type { IsDefinedReturn };

package/dist/index.mjs

@@ -0,0 +1,7 @@
+import { unref } from 'vue';
+
+function isDefined(v) {
+  return unref(v) != null;
+}
+
+export { isDefined };

package/logo.svg

@@ -0,0 +1,34 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96" width="256" height="256">
+  <defs>
+    <linearGradient id="bg-grad" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#2c3e50;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#1a252f;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+
+  <!-- Background -->
+  <rect width="96" height="96" rx="16" fill="url(#bg-grad)"/>
+
+  <!-- Decorative corner accent -->
+  <path d="M96 0v20c0-11.046-8.954-20-20-20H96z" fill="#3498db" opacity="0.12"/>
+
+  <!-- Vue badge -->
+  <g transform="translate(8, 8)">
+    <rect width="18" height="9" rx="2" fill="#3498db"/>
+    <text x="9" y="6.8" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="4.5" font-weight="700" fill="white">VUE</text>
+  </g>
+
+  <!-- Category icon -->
+  <g>
+    <path d="M42 20l-8 8 8 8" fill="none" stroke="#3498db" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M54 20l8 8-8 8" fill="none" stroke="#3498db" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/><line x1="51" y1="18" x2="45" y2="38" stroke="#3498db" stroke-width="2" stroke-linecap="round"/>
+  </g>
+
+  <!-- Function name - textLength ensures it fits within bounds -->
+  <text x="48" y="57" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="10" font-weight="600" fill="white" textLength="60" lengthAdjust="spacingAndGlyphs">Is Defined</text>
+
+  <!-- Category label -->
+  <text x="48" y="72" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="7" fill="#3498db" opacity="0.85">Utilities</text>
+
+  <!-- Bottom accent line -->
+  <rect x="28" y="82" width="40" height="2" rx="1" fill="#3498db" opacity="0.5"/>
+</svg>

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "vue-is-defined",
+  "version": "1.0.0",
+  "description": "Vue 3 type guard checking if ref value is not null/undefined",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "logo.svg",
+    "banner.svg"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "vue",
+    "vue3",
+    "vue-3",
+    "composable",
+    "composition-api",
+    "vueuse",
+    "utility",
+    "helper",
+    "utils",
+    "defined",
+    "nullish",
+    "type-guard",
+    "typescript",
+    "check",
+    "null",
+    "undefined",
+    "isDefined"
+  ],
+  "author": "VueFrag",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vuefrag/vue-is-defined.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vuefrag/vue-is-defined/issues"
+  },
+  "homepage": "https://github.com/vuefrag/vue-is-defined#readme",
+  "peerDependencies": {
+    "vue": ">=3.0.0"
+  },
+  "devDependencies": {
+    "unbuild": "^2.0.0",
+    "typescript": "^5.0.0",
+    "vue": "^3.4.0"
+  }
+}