## 📝 Table of Contents

- [About](#about)
- [Usage](#usage)
- [Authors](#authors)

## 🧐 About <a name = "about"></a>

A simple YouTube video downloader for audio and video formats.

### Installing


```sh
yarn add @dark-yasiya/yt-dl.js
```

or

```sh
npm i @dark-yasiya/yt-dl.js
```

## 🍟 Usage <a name="usage"></a>

```ts
const { ytsearch, ytmp3, ytmp4 } = require('@dark-yasiya/yt-dl.js')
```


## Yt Search

```ts
const text = "lelena";
const result = ytsearch(text);
console.log(result);
```
```ts
{
  result: true,
  creator: '@DarkYasiya',
  results: [
    {
      type: 'video',
      videoId: '0geqOYqwL0s',
      url: 'https://youtube.com/watch?v=0geqOYqwL0s',
      title: 'Lelena (ලෙලෙනා) - Nilan Hettiarachchi Official Music Video',
      description: 'Title | Lelena Artiste | Nilan Hettiarachchi Music Produced by Chamath Sangeeth Lyrics | Dulan ARX ( Dulanja Alwis) Directed by ...',
      image: 'https://i.ytimg.com/vi/0geqOYqwL0s/hq720.jpg',
      thumbnail: 'https://i.ytimg.com/vi/0geqOYqwL0s/hq720.jpg',
      seconds: 195,
      timestamp: '3:15',
      duration: [Object],
      ago: '3 years ago',
      views: 37740125,
      author: [Object]
    },
    {
      type: 'video',
      videoId: 'AFqtArWpv-w',
      url: 'https://youtube.com/watch?v=AFqtArWpv-w',
      title: 'Nilan Hettiarachchi - ලෙලෙනා | Lelena (Lyrics)',
      description: 'Title | Lelena Artiste | Nilan Hettiarachchi Music Produced by Chamath Sangeeth Lyrics | Dulan ARX ( Dulanja Alwis) Directed by ...',
      image: 'https://i.ytimg.com/vi/AFqtArWpv-w/hq720.jpg',
      thumbnail: 'https://i.ytimg.com/vi/AFqtArWpv-w/hq720.jpg',
      seconds: 194,
      timestamp: '3:14',
      duration: [Object],
      ago: '3 years ago',
      views: 529654,
      author: [Object]
    },
    {
      type: 'video',
      videoId: 'qcKQCymbXWE',
      url: 'https://youtube.com/watch?v=qcKQCymbXWE',
      title: 'ලෙලෙනා - Lelena | Nilan Hettiarachchi song | Chipmunks & Himabole version song with lyrics',
      description: 'lelena Himabole Studio Thanks for watching ❤ Like Comment Share.',
      image: 'https://i.ytimg.com/vi/qcKQCymbXWE/hq720.jpg',
      thumbnail: 'https://i.ytimg.com/vi/qcKQCymbXWE/hq720.jpg',
      seconds: 169,
      timestamp: '2:49',
      duration: [Object],
      ago: '3 years ago',
      views: 1760313,
      author: [Object]
    } ... more results
  ]
}
```

## Download Ytmp3
```ts
const yturl = "https://www.youtube.com/watch?v=vOv2i88NmA4";
const result = ytmp3(yturl);
console.log(result);
```
```ts
{
  status: true,
  creator: '@DarkYasiya',
  result: {
    type: 'video',
    videoId: 'vOv2i88NmA4',
    url: 'https://youtube.com/watch?v=vOv2i88NmA4',
    title: 'Age Sinahawa Thahanam | ඇගෙ සිනහව තහනම් | Vini Productions - විනී',
    description: 'Age Sinahawa Thahanam | ඇගෙ සිනහව තහනම් | Vini Productions - විනී ✓1XBET MELBET ගහලා ...',
    image: 'https://i.ytimg.com/vi/vOv2i88NmA4/hq720.jpg',
    thumbnail: 'https://i.ytimg.com/vi/vOv2i88NmA4/hq720.jpg',
    seconds: 1541,
    timestamp: '25:41',
    duration: {
      toString: [Function: toString],
      seconds: 1541,
      timestamp: '25:41'
    },
    ago: '2 days ago',
    views: 2003354,
    author: {
      name: 'Vini Productions - විනී',
      url: 'https://youtube.com/@viniproductionsofficial'
    }
  },
  download: {
    url: 'https://dl187.filemate11.shop/?file=M3R4SUNiN3JsOHJ6WWQ2a3NQS1Y5ZGlxVlZIOCtyZ0ZuOUJ4OUJrdEFLTk5zWXhrNCt5aEs4aEJMNnBFaHMrSFFadDJvM3VBSnBXdVlFcXI0TjEvWVRqRTBvWjRtMmlLcTkxbGZKazBkRUM5dWJmbXMyRXpxMUN3Sm95SU1PZ1RUeUErK3hBb2xnUERpZE9DL0RUYzlsajk0bS9VS1h4ZTl4NWJlTmVHdEwwWmtFeWJLdFd5bHJKZDVtMnA2NVJBa2NDUHV3WGp3S1kzdDlKbUZROHhWc0FZKzgyd2g2Q0pnQmRjb3M5WitCenFwUEwxUUpnOEVLQ2hhVFprTm45TXU4bjJVdzRLMmljYnZUNlkrNzkycXpJdktlVW56blNiNzZEZ1BtZTJjK09pQVp5VWVhNjZvOHFrenRJbnVsblJyL0hDaUpOTmsxWDJINXV0RUlsWjV4OTI1N0dHNC9NMXlsTzYwVkpMeFBNQTNrNmhKUmhrSGNFWWNpRkpOTnBLQXl4Tg%3D%3D',
    size: '23.52 MB'
  }
}
```

## Download Ytmp4

```ts
const yturl = "https://www.youtube.com/watch?v=vOv2i88NmA4";
const quality = "360p";
const result = ytmp4(yturl, quality);
console.log(result);
```
```ts
{
  status: true,
  creator: '@DarkYasiya',
  result: {
    type: 'video',
    videoId: 'vOv2i88NmA4',
    url: 'https://youtube.com/watch?v=vOv2i88NmA4',
    title: 'Age Sinahawa Thahanam | ඇගෙ සිනහව තහනම් | Vini Productions - විනී',
    description: 'Age Sinahawa Thahanam | ඇගෙ සිනහව තහනම් | Vini Productions - විනී ✓1XBET MELBET ගහලා ...',
    image: 'https://i.ytimg.com/vi/vOv2i88NmA4/hq720.jpg',
    thumbnail: 'https://i.ytimg.com/vi/vOv2i88NmA4/hq720.jpg',
    seconds: 1541,
    timestamp: '25:41',
    duration: {
      toString: [Function: toString],
      seconds: 1541,
      timestamp: '25:41'
    },
    ago: '2 days ago',
    views: 2005666,
    author: {
      name: 'Vini Productions - විනී',
      url: 'https://youtube.com/@viniproductionsofficial'
    }
  },
  download: {
    url: 'https://carl89.oceansaver.in/pacific/?Fp8tZWSaFLBxdoyy08bKkra',
  }
}
```

## 🖋 Authors <a name = "authors"></a>

- [@DarkYasiya](https://github.com/DarkYasiyaofc) - scraped author