https://github.com/bbc/get-title
Extract the best title value from within HTML head elements.
https://github.com/bbc/get-title
Last synced: 9 months ago
JSON representation
Extract the best title value from within HTML head elements.
- Host: GitHub
- URL: https://github.com/bbc/get-title
- Owner: bbc
- License: apache-2.0
- Created: 2016-06-30T10:49:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T07:55:28.000Z (over 2 years ago)
- Last Synced: 2025-03-22T06:51:14.260Z (10 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/get-title
- Size: 76.2 KB
- Stars: 17
- Watchers: 20
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# get-title [](https://travis-ci.org/bbc/get-title)
> A promise to extract the best title value contained in some HTML content.
The streaming approach helps remaining efficient in spite of malformed or very large HTML documents.
**Notice**: this module requires `node>=4` to work.
# Install
```bash
$ npm install --save get-title
```
# Usage
## Node API
```js
const getTitle = require('get-title');
const hyperquest = require('hyperquest');
const stream = hyperquest('https://www.bbc.co.uk/news/uk-england-tyne-36570429');
getTitle(stream).then(title => {
// ...
});
```
You can also analyse a set of `` tags provided as an array of objects
(eg: like these provided by [`parse-head`](https://npmjs.com/parse-head)):
```js
const getTitle = require('get-title/from-array');
const headers = [ { nodeName: 'TITLE', innerText: '...' }, ... ];
getTitle(headers).then(title => {
// ...
});
```
## Command line
```bash
Usage: cat some/file.html | get-title [options]
Options:
--help Show help [boolean]
Examples:
cat some/file.html | get-title
curl -Ss https://www.bbc.co.uk/news/uk-england-tyne-36570429 | get-title
> Lickety Split ice cream parlour's van stolen - BBC News
```
# License
> Copyright 2020, British Broadcasting Corporation
>
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at
>
> http://www.apache.org/licenses/LICENSE-2.0
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.