Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmammino/tall
Promise-based, No-dependency URL unshortner (expander) module for Node.js
https://github.com/lmammino/tall
library module no-dependencies node nodejs promise promises typescript typescript-library url url-expand url-parsing url-shortener url-unshorten
Last synced: about 1 month ago
JSON representation
Promise-based, No-dependency URL unshortner (expander) module for Node.js
- Host: GitHub
- URL: https://github.com/lmammino/tall
- Owner: lmammino
- License: mit
- Created: 2017-03-28T19:37:25.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T08:39:17.000Z (over 1 year ago)
- Last Synced: 2024-07-22T03:03:36.310Z (about 2 months ago)
- Topics: library, module, no-dependencies, node, nodejs, promise, promises, typescript, typescript-library, url, url-expand, url-parsing, url-shortener, url-unshorten
- Language: TypeScript
- Homepage: https://lmammino.github.io/tall/
- Size: 597 KB
- Stars: 69
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tall
[](https://npm.im/tall)
[](https://github.com/lmammino/tall/actions?query=workflow%3Amain)
[](https://codecov.io/gh/lmammino/tall)
[](https://standardjs.com)
[](https://www.typescriptlang.org/)
Promise-based, No-dependency URL unshortner (expander) module for Node.js 16+.
**Note**: This library is written in **TypeScript** and type definitions are provided.
## Install
Using npm
```bash
npm install --save tall
```
or with yarn
```bash
yarn add tall
```
## Usage
ES6+ usage:
```javascript
import { tall } from 'tall'
tall('http://www.loige.link/codemotion-rome-2017')
.then((unshortenedUrl) => console.log('Tall url', unshortenedUrl))
.catch((err) => console.error('AAAW 👻', err))
```
With Async await:
```javascript
import { tall } from 'tall'
async function someFunction() {
try {
const unshortenedUrl = await tall(
'http://www.loige.link/codemotion-rome-2017'
)
console.log('Tall url', unshortenedUrl)
} catch (err) {
console.error('AAAW 👻', err)
}
}
someFunction()
```
ES5:
```javascript
var { tall } = require('tall')
tall('http://www.loige.link/codemotion-rome-2017')
.then(function (unshortenedUrl) {
console.log('Tall url', unshortenedUrl)
})
.catch(function (err) {
console.error('AAAW 👻', err)
})
```
## Options
It is possible to specify some options as second parameter to the `tall` function.
Available options are the following:
- `method` (default `"GET"`): any available HTTP method
- `maxRedirects` (default `3`): the number of maximum redirects that will be followed in case of multiple redirects.
- `headers` (default `{}`): change request headers - e.g. `{'User-Agent': 'your-custom-user-agent'}`
- `timeout`: (default: `120000`): timeout in milliseconds after which the request will be cancelled
- `plugins`: (default: `[locationHeaderPlugin]`): a list of [plugins](#plugins) for adding advanced behaviours
In addition, any other options available on [http.request()](`https://nodejs.org/api/http.html#httprequestoptions-callback`) or `https.request()` are accepted. This for example includes `rejectUnauthorized` to disable certificate checks.
Example:
```javascript
import { tall } from 'tall'
tall('http://www.loige.link/codemotion-rome-2017', {
method: 'HEAD',
maxRedirect: 10
})
.then((unshortenedUrl) => console.log('Tall url', unshortenedUrl))
.catch((err) => console.error('AAAW 👻', err))
```
## Plugins
Since `tall` v5+, a plugin system for extending the default behaviour of tall is available.
By default `tall` comes with 1 single plugin, the `locationHeaderPlugin` which is enabled by default. This plugin follows redirects by looking at the `location` header in the HTTP response received from the source URL.
You might want to write your own plugins to have more sophisticated behaviours.
Some example?
- Normalise the final URL if the final page has a `` tag in the `` of the document
- Follow HTML meta refresh redirects (``)
### Known plugins
- [`tall-plugin-meta-refresh`](https://npm.im/tall-plugin-meta-refresh) (official): follows redirects in `` tags
Did you create a plugin for `tall`? Send us a PR to have it listed here!
## How to write a plugin
A plugin is simply a function with a specific signature:
```typescript
export interface TallPlugin {
(url: URL, response: IncomingMessage, previous: Follow | Stop): Promise<
Follow | Stop
>
}
```
So the only thing you need to do is to write your custom behaviour following this interface. But let's discuss briefly what the different elements mean here:
- `url`: Is the current URL being crawled
- `response`: is the actual HTTP response object representing the current
- `previous`: the decision from the previous plugin execution (continue following a given URL or stop at a given URL)
Every plugin is executed asynchronously, so a plugin returns a Promise that needs to resolve to a `Follow` or a `Stop` decision.
Let's deep dive into these two concepts. `Follow` and `Stop` are defined as _follows_ (touché):
```typescript
export class Follow {
follow: URL
constructor(follow: URL) {
this.follow = follow
}
}
export class Stop {
stop: URL
constructor(stop: URL) {
this.stop = stop
}
}
```
`Follow` and `Stop` are effectively simple classes to express an intent: _should we follow the `follow` URL or should we stop at the `stop` URL?_
Plugins are executed following the middleware pattern (or chain of responsibility): they are executed in order and the information is propagated from one to the other.
For example, if we initialise `tall` with `{ plugins: [plugin1, plugin2] }`, for every URL, `plugin1` will be executed before `plugin2` and the decision of `plugin1` will be passed over onto `plugin2` using the `previous`) parameter.
## How to write and enable a plugin
Let's say we want to add a plugin that allows us to follow HTML meta refresh redirects, the code could look like this:
```typescript
// metarefresh-plugin.ts
import { IncomingMessage } from 'http'
import { Follow, Stop } from 'tall'
export async function metaRefreshPlugin(
url: URL,
response: IncomingMessage,
previous: Follow | Stop
): Promise {
let html = ''
for await (const chunk of response) {
html += chunk.toString()
}
// note: This is just a dummy example to illustrate how to use the plugin API.
// It's not a great idea to parse HTML using regexes.
// If you are looking for a plugin that does this in a better way check out
// https://npm.im/tall-plugin-meta-refresh
const metaHttpEquivUrl = html.match(
/meta +http-equiv="refresh" +content="\d;url=(http[^"]+)"/
)?.[1]
if (metaHttpEquivUrl) {
return new Follow(new URL(metaHttpEquivUrl))
}
return previous
}
```
Then, this is how you would use your shiny new plugin:
```typescript
import { tall, locationHeaderPlugin } from 'tall'
import { metaRefreshPlugin } from './metarefresh-plugin'
const finalUrl = await tall('https://loige.link/senior', {
plugins: [locationHeaderPlugin, metaRefreshPlugin]
})
console.log(finalUrl)
```
Note that we have to explicitly pass the `locationHeaderPlugin` if we want to retain `tall` original behaviour.
## Contributing
Everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/tall/issues).
> **Note**: Since Tall v6, the project structure is a monorepo, so you'll need to use a recent version of npm that supports workspaces (e.g. npm 8.5+)
## License
Licensed under [MIT License](LICENSE). © Luciano Mammino.