iso-3166-1 - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

dist/index.d.ts

@@ -30,3 +30,10 @@ import { Country } from './iso-3166';
 export declare const whereNumeric: (numeric: string | number) => Country | undefined;
+/**
+ * Get all countries.
+ *
+ * @returns {Array<Country>}
+ */
+export declare const all: () => Country[];
 declare const _default: {
+    all: () => Country[];
     whereCountry: (name: string) => Country | undefined;
@@ -33,0 +40,0 @@ whereAlpha2: (alpha2: string) => Country | undefined;

dist/index.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.whereNumeric = exports.whereAlpha3 = exports.whereAlpha2 = exports.whereCountry = void 0;
+exports.all = exports.whereNumeric = exports.whereAlpha3 = exports.whereAlpha2 = exports.whereCountry = void 0;
 const iso_3166_1 = __importDefault(require("./iso-3166"));
@@ -45,3 +45,10 @@ /**
 };
+/**
+ * Get all countries.
+ *
+ * @returns {Array<Country>}
+ */
+exports.all = () => iso_3166_1.default;
 exports.default = {
+    all: exports.all,
     whereCountry: exports.whereCountry,
@@ -48,0 +55,0 @@ whereAlpha2: exports.whereAlpha2,

package.json

 {
   "name": "iso-3166-1",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Lookup information with ISO 3166-1 alpha-2, ISO 3166-1 alpha-3 and ISO 3166-1 numeric",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -75,3 +75,20 @@ # iso-3166-1
 
+Get all countries
+```javascript
+const iso = require('iso-3166-1');
+
+console.log(iso.all());
+/** Returns:
+  [
+    {
+      country: 'Norway',
+      alpha2: 'NO',
+      alpha3: 'NOR',
+      numeric: '578'
+    }
+  ]
+*/
+```
+
 ### License
 MIT © [Daniel Eckermann](http://danieleckermann.com)

tests/tests.ts

@@ -0,6 +1,12 @@
+import { expect } from 'chai';
 import { describe, it } from 'mocha';
-import { expect } from 'chai';
+
 import iso from '../src/';
+import countries from '../src/iso-3166';
 
 describe('ISO-3166 test suite', function () {
+  it('returns an array of all countries', function() {
+    expect(iso.all()).to.be.equal(countries);
+  });
+
   it('returns a country by alpha-2 with lowercase letters', function () {
@@ -7,0 +13,0 @@ const deepObject = iso.whereAlpha2('no');

No alert changes

Improved metrics

Total package byte prevSize

38066

increased by1.71%

Lines of code

1679

increased by1.08%

Number of lines in readme file

93

increased by22.37%

No dependency changes