# ping-lazymention

> Ping a lazymention server

Latest version **1.0.1** (published 2018-05-18) · LGPL-3.0+ license · 0 weekly downloads

## Install

```sh
npm install ping-lazymention
pnpm add ping-lazymention
yarn add ping-lazymention
bun add ping-lazymention
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-05-18 |
| First published | 2017-12-31 |
| Weekly downloads | 0 |
| License | LGPL-3.0+ |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 54 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | AJ Jordan |
| Maintainers | strugee |
| Keywords | lazymention, ping, gulpfriendly |

## Links

- npm: https://www.npmjs.com/package/ping-lazymention
- Repository: https://github.com/strugee/ping-lazymention
- Homepage: https://github.com/strugee/ping-lazymention#readme
- Issues: https://github.com/strugee/ping-lazymention/issues
- npm.io page: https://npm.io/package/ping-lazymention

## Dependencies (1)

- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.2

## Recent versions

- 1.0.1 (latest) — 2018-05-18
- 1.0.0 — 2017-12-31

## README

# `ping-lazymention`

[![Build Status](https://travis-ci.org/strugee/ping-lazymention.svg?branch=master)](https://travis-ci.org/strugee/ping-lazymention)
[![Coverage Status](https://coveralls.io/repos/github/strugee/ping-lazymention/badge.svg?branch=master)](https://coveralls.io/github/strugee/ping-lazymention?branch=master)
[![npm](https://img.shields.io/npm/v/ping-lazymention.svg)](https://npmjs.com/package/ping-lazymention)
[![Greenkeeper badge](https://badges.greenkeeper.io/strugee/ping-lazymention.svg)](https://greenkeeper.io/)

Ping a [lazymention](https://github.com/strugee/lazymention) server

Originally designed as a [gulp](https://gulpjs.com/) task, but is useful otherwise too.

## Installation

    npm install ping-lazymention

## Usage

The function exported by the module takes two arguments. The first is the full URL to a lazymention API endpoint. The second is the URL you want to submit for processing.

When you call the module, it will return a new function configured with the two URLs. This second function takes one parameter, a callback function that will be invoked when the lazymention server has been (un)successfully pinged. This second function is designed to be a gulp task but it's not really tied to gulp.

The module logs stuff to the console. This is nice if you're using gulp and probably annoying otherwise. I would take PRs to improve this situation, for example by adding an options object argument with a `quiet` option.

## Example

Example inside a `gulpfile.js`:

```js
var gulp = require('gulp');
var ping = require('ping-lazymention');

gulp.task('ping', ping('http://example.com:21507/jobs/submit', 'https://example.com/blog/'));
```

This example assumes that you have lazymention running on `example.com:21507`, and your blog that you want it to crawl is at `https://example.com/blog/`. Note that we've specified the full path to the API (i.e. `/jobs/submit`) in the first URL.

## License

LGPL 3.0+

## Author

AJ Jordan <alex@strugee.net>

---
_Source: https://npm.io/package/ping-lazymention · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._