https://github.com/wabarc/archiver

Archive webpages
https://github.com/wabarc/archiver

archiver javascript node nodejs npm npm-package telegram telegram-channel typescript wayback wayback-archiver

Last synced: 30 days ago
JSON representation

Archive webpages

• Host: GitHub
• URL: https://github.com/wabarc/archiver
• Owner: wabarc
• License: gpl-3.0
• Created: 2020-10-16T15:56:52.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T02:22:12.000Z (about 1 year ago)
• Last Synced: 2024-12-12T07:48:45.635Z (2 months ago)
• Topics: archiver, javascript, node, nodejs, npm, npm-package, telegram, telegram-channel, typescript, wayback, wayback-archiver
• Language: TypeScript
• Homepage:
• Size: 777 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# archiver

Read this in other languages: English | [简体中文](./README_zh-CN.md)

Archive webpages from Telegram channel and etc.

## Installation

Using npm:

```bash

npm install @wabarc/archiver

```

Using yarn:

```bash

yarn add @wabarc/archiver

```

## Example

```javascript

import { Archiver } from '@wabarc/archiver';

// const archiver = require('@wabarc/archiver');

const archived = await new Archiver().telegram({ channel: 'channel_name', msgid: 1 }).start();

console.log(archived)

```

## Instance methods

The available instance methods are listed below.

- archiver#telegram({ channel: string, msgid: number })

- archiver#start()

- archiver#do()

- archiver#stage()

## Request Params

### Telegram

These are the available options for archival webpage from Telegram channel. `channel` and `msgid` is required.

```javascript

{

  // `channel` is the Telegram channel name

  channel: 'wabarc_testing',

  // `msgid` is the message id published on the Telegram channel.

  msgid: 1

}

```

## Response Schema

```javascript

[

  {

    id: 1,

    url: 'https://example.org/',

    title: 'Example ORG',

    content: 'body content',

    success: true

  }

]

```

## License

This software is released under the terms of the GNU General Public License v3.0. See the [LICENSE](https://github.com/wabarc/archiver/blob/main/LICENSE) file for details.