npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mimik/validation-helper

v1.5.3

Published

Validation helper for mimik microservices

Downloads

4

Readme

validation-helper

Example

const validationHelper = require('@mimik/validation-helper');

validation-helper~validateCompositeId(id) ⇒ string

A composite id is a base64 encoded object with the following structure:

 {
   "nodeId": (a string),
   "localLinkNetworkId": (a string)
 }

Kind: inner method of validation-helper
Returns: string - The id.
Category: sync
Throws:

  • object An error with the appropriate message.

| Param | Type | Description | | --- | --- | --- | | id | string | Id to validate as a composite id. |

validation-helper~validateOauthId(id, userId, onBehalfId) ⇒ string

Validate oauth id.

Kind: inner method of validation-helper
Returns: string - The userid or the onbehalfId.
Category: sync
Throws:

  • object Will throw an error is no match is made.

| Param | Type | Description | | --- | --- | --- | | id | string | The id to validate. | | userId | string | The userId to validate the id against. | | onBehalfId | string | The onBehalfId to validate the id against. |

validation-helper~validateLocalLinkNetworkId() ⇒ string

The localLinkNetwork id is a base64 encoded object with the following structure:

 {
   "networkAddress": (an address),
   "publicAddress": (an address)
 }

The publicAddress is not optional. If the localLinkNetwork is not present, the networkAddress is not optional and the returned localLinkNetworkId will be build.

Kind: inner method of validation-helper
Returns: string - The localLinkNetwork id.
Category: sync
Throws:

  • object Will throw an error with the appropriate message.

Params: string localLinkNetworkId - The id to validate.
Params: IP<string> networkAddress - An address to validate the id.
Params: IP<string> publicAddress - An address to validate the id.

validation-helper~validateLocation(lon, lat, elevation, type) ⇒ object

The location object has the following structure:

 {
   "type": "Point",
   "coordinates": [lon, lat],
   "elevation": (elevation), if present
 }

Kind: inner method of validation-helper
Returns: object - The location object.
Category: sync
Throws:

  • object Will throw an error with the appropriate message.

| Param | Type | Description | | --- | --- | --- | | lon | number | Longitude (-180, 180) in degree. | | lat | number | Latitude (-90, 90) in degree. | | elevation | number | Elevation (-5000, 50000) in meters. | | type | string | Type of coordinates (Point). |

validation-helper~validateGeoLocation(location) ⇒ object

If location is not present `null will be returned.

Kind: inner method of validation-helper
Returns: object - The location.
Category: sync
Throws:

  • Will throw an error if the location fails validation.

| Param | Type | Description | | --- | --- | --- | | location | object | A GeoJSON location object. |

validation-helper~validateUniqueAttributes(attributes) ⇒ Array.<object>

Validate unique attributes.

Kind: inner method of validation-helper
Returns: Array.<object> - An array of unique attributes.
Category: sync

| Param | Type | Description | | --- | --- | --- | | attributes | Array.<object> | An array of attributes. |