npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nuxt-link-preview

v0.1.5

Published

Link preview module for Nuxt.js

Downloads

68

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

khalidsheetkhalidsheet

Keywords

Readme

Nuxt3 Link Preview

License: MIT TypeScript npm bundle size

A Nuxt.js 3.x module for previewing links using the Composition API.

Installation

  1. Add the module to your Nuxt.js project:
npm install --save nuxt-link-preview
  1. Add nuxt-link-preview to the modules section of your nuxt.config.js file:
modules: [
  'nuxt-link-preview'
],

Types

interface Preview {
    title: string,
    description: string,
    image: string,
    url: string,
    meta: Meta[]
}

interface Meta {
        name: string;
        value: string
}

Usage

In your project, you may create a new api endpoint inside /server/api called preview.ts or preview.get.ts

export default defineEventHandler(async (event) => {
  const body = getQuery(event);
  const preview = await useLinkPreview(<string>body.url);
  return { preview };
});

API

useLinkPreview(url: string): Preview

Fetches link preview data for the given url. Returns an object of the Preview interface with the following properties:

  • title The title of the page
  • description A short descriprion of the page
  • image A URL to the main image of the page
  • url The URL of the page
  • meta The whole meta tags inside <head> tag

Development

  • Run npm run dev:prepare to generate type stubs.
  • Use npm run dev to start playground in development mode.

Contributing

  1. Fork the Repo
  2. Create your feature/bugfix branch (git checkout -b my-branch)
  3. Commit your changes (git commit -am "Add/fixed something somewhere")
  4. Push to the branch (git push origin my-branch)
  5. Create new Pull Request

License

The project is licensed under the MIT License -- see the LICENSE file for details.