@guardian/libs
TypeScript icon, indicating that this package has built-in type declarations

16.0.2 • Public • Published

@guardian/libs

npm (scoped) ES version npm type definitions

A collection of JavaScript libraries and TypeScript types for Guardian projects

ArticleElementRole

Type that describes the role of an element in an article.

Cookies

API over document.cookies.

Countries

Country data and methods to access it.

Format

Codified editorial design and information architecture.

Locale

Get the user’s current location.

Switches

Get the active switches on theguardian.com.

isBoolean

Check whether a value is a boolean.

isNonNullable

Check whether a value is a NonNullable.

isObject

Checks whether a value is a plain object (i.e. {}-like).

isOneOf

Check whether a value is one of a set of literal string or numbers.

isString

Check whether a value is a string.

isUndefined

Check whether a value is undefined.

joinUrl

Combines separate url parts into one valid url string.

loadScript

Inject an external JavaScript file.

log, debug

Selectively log team-specific messages to the console.

Ophan

Types relating to Ophan.

Performance

API over window.performance with hooks into log the data warehouse.

storage

Robust API over localStorage and sessionStorage.

timeAgo

Format absolute dates as time-ago strings.

Installation

Generic badge

yarn add @guardian/libs

or

npm install @guardian/libs

then

import { loadScript, storage, ...etc } from '@guardian/libs';

Bundling

This package uses ES2020.

If your target environment does not support that, make sure you transpile this package when bundling your application.

Readme

Keywords

none

Package Sidebar

Install

npm i @guardian/libs

Weekly Downloads

1,865

Version

16.0.2

License

MIT

Unpacked Size

446 kB

Total Files

250

Last publish

Collaborators

  • joecowton1
  • guardian-developers
  • akash1810
  • reetta
  • sndrs
  • mxdvl