Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@podium/utils
Advanced tools
[![Build Status](https://travis.schibsted.io/Podium/utils.svg?token=9zzG3RHGpsXkFZyESkVu)](https://travis.schibsted.io/Podium/utils)
Misc common / generic utility methods.
$ npm install @podium/utils
This module has the following API:
Checks if a value is a string.
The method takes the following arguments:
*
- A value to check. Required.Returns a boolean.
Checks if a value is a function.
The method takes the following arguments:
*
- A value to check. Required.Returns a boolean.
Constructs an pathname from all arguments. Returned pathname will always end without
a /
and if the first argument starts with a /
it will be preserved.
const utils = require('@podium/utils');
const foo = 'foo/a/';
const bar = '/bar/b/';
const xyz = '/xyz/';
const pathname = utils.pathnameBuilder(foo, bar, xyz);
console.log(pathname); // outputs: foo/a/bar/b/xyz
Constructs an absolute URI out of a absolute manifest URI and a relative URI.
The method takes the following arguments:
String
- Relative URI. Required.String
- Absolute manifest URI to append the input too. Required.String
- Relative path to be appended at the end of the URI. Optional.Returns a resolved URI.
const utils = require('@podium/utils');
const manifest = 'http://foo.site.com/bar/manifest.json';
const content = '/here/is/content.html';
const url = utils.uriBuilder(content, manifest);
console.log(url); // outputs: http://foo.site.com/bar/here/is/content.html
Checks if a URI is relative
The method takes the following arguments:
String
- The URI to check. Required.Returns a Boolean.
const utils = require('@podium/utils');
utils.uriIsRelative('http://foo.site.com/bar/'); // false
utils.uriIsRelative('/bar/'); // true
Check if a URI is absolute or relative and if relative compose an absolute URI out of a absolute mainfest URI.
The method takes the following arguments:
String
- Relative or absolute URI. Required.String
- Absolute manifest URI to append the possible relative input too. Required.String
- Relative path to be appended at the end of the URI. Optional.Returns a resolved URI.
const utils = require('@podium/utils');
const manifest = 'http://foo.site.com/bar/manifest.json';
const content = 'http://foo.site.com/here/is/content.html';
const url = utils.uriRelativeToAbsolute(content, manifest);
console.log(url); // outputs: http://foo.site.com/here/is/content.html
Set a value on a property on .locals.podium on a http response object. Ensures that .locals.podium exists on the http response object.
If property is not provided, .locals.podium will be created, if not already existing, on the response object.
The method takes the following arguments:
Object
- A http response object.String
- Property for the value.String
- Value to store on the property.The http response object.
const obj = utils.setAtLocalsPodium({}, 'foo', 'bar');
/*
obj is now:
{
locals: {
podium: {
foo: 'bar',
},
},
}
*/
Get the value from a property on .locals.podium on a http response object Ensures that .locals.podium exists on the http response object.
Object
- A http response objectString
- Property for the valuereturns The property, or null
if it does not exist
Get the value from a property on .locals.podium on a http response object and sets its value on another key.
Object
- A http response objectString
- Property for the existent valueString
- Property for the duplicated value@returns {Object} The http response object
Serialize a context object into a http header object.
The method takes the following arguments:
Object
- A http headers object the context will be copied into.Object
- A contect object to copy from*
- An argument value passed on to the function if a context value is a function.A http header object.
const context = {
'podium-foo': 'bar',
'podium-bar': 'foo',
};
let headers = {
test: 'xyz',
};
headers = utils.serializeContext(headers, context);
/*
headers is now:
{
'podium-foo': 'bar',
'podium-bar': 'foo',
test: 'xyz',
}
*/
Deserialize a context object from a http header object
The method takes the following arguments:
Object
- A http headers object the context will be extracted from.String
- The prefix used to mark what properties are context propertiesA object containing context properties and values
const headers = {
bar: 'foo',
'podium-foo': 'bar podium',
};
const context = utils.deserializeContext(headers);
// context is: { foo: 'bar podium' }
FAQs
Common generic utility methods shared by @podium modules.
The npm package @podium/utils receives a total of 9,344 weekly downloads. As such, @podium/utils popularity was classified as popular.
We found that @podium/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.