1.0.0 • Published 5 months ago

gulf-of-npm v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

gulf-of-npm

A simple npm package that returns the appropriate Gulf name based on a country code.

Installation

npm install gulf-of-npm

Usage

const getGulfName = require('gulf-of-npm');

// For US
console.log(getGulfName('US')); // Output: Gulf of America

// For any other country
console.log(getGulfName('MX')); // Output: Gulf of Mexico

API

getGulfName(countryCode)

Parameters

  • countryCode (string): A two-letter ISO country code

Returns

  • Returns 'Gulf of America' if the country code is 'US'
  • Returns 'Gulf of Mexico' for all other country codes

Throws

  • TypeError: If the input is not a string

License

MIT

1.0.0

5 months ago