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

@sandfox/arn

v2.1.0

Published

Parser for Amazon Resource Name strings

Downloads

521

Readme

arn

Parser for Amazon Resource Name strings.

Build Status

more info

Does what it says on the tin! Parses an Amazon Resource Name and gives it back as object. Loosely based upon the aws golang implementation.

Benefits:

  • Single implementation file
  • Dependency-free
  • Includes TypeScript type definitions

install

With npm do:

npm install @sandfox/arn

api

parse : Parse parses an ARN into its constituent parts. Empty sections in the ARN are represented by empty strings.

const { parse } = require('@sandfox/arn');
const arn = parse("arn:aws:iam::123456789012:server-certificate/division_abc/subdivision_xyz/ProdServerCert");

output:

{
  partition: 'aws',
  service: 'iam',
  region: '',
  accountID: '123456789012',
  resource: 'server-certificate/division_abc/subdivision_xyz/ProdServerCert'
}

Fields:

  • partition: The partition that the resource is in. For standard AWS regions, the partition is "aws". If you have resources in other partitions, the partition is "aws-partitionname". For example, the partition for resources in the China (Beijing) region is "aws-cn".
  • service: The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of namespaces, see http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces.
  • region: The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted.
  • accountID: The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted.
  • resource: The content of this part of the ARN varies by service. It often includes an indicator of the type of resource — for example, an IAM user or Amazon RDS database - followed by a slash (/) or a colon (:), followed by the resource name itself. Some services allows paths for resource names, as described in http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-paths.

toString : Returns the canonical representation of an ARN in object form as returned by parse. Any missing sections will be truncated.

const { toString } = require('@sandfox/arn');
const arn = {
  partition: 'aws',
  service: 'iam',
  accountID: '123456789012',
  resource: 'server-certificate/division_abc/subdivision_xyz/ProdServerCert'
}

console.log(toString(arn))

output

'arn::aws:iam::123456789012:server-certificate/division_abc/subdivision_xyz/ProdServerCert'

license

MIT