@digitransit-search-util/digitransit-search-util-get-label 1.0.5 → 1.0.6

package/README.md

@@ -1,21 +1,21 @@
-# @digitransit-search-util/get-label
+# @digitransit-search-util/digitransit-search-util-get-label
 
-# getLabel
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-<DESCRIPTION>
+## getLabel
 
-**Parameters**
-<PARAMETERS>
+Returns label for properties
 
-**Examples**
+### Parameters
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the digitransit-search-util project. -->
+*   `properties` **any** object
 
+Returns **[Boolean][1]** true/false
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 ---
 
-This module is part of the Digitransit project. It is maintained in the
+This module is part of the Digitransit-ui project. It is maintained in the
 [HSLdevcom/digitransit-ui](https://github.com/HSLdevcom/digitransit-ui) repository, where you can create
 PRs and issues.
 
@@ -24,11 +24,5 @@ PRs and issues.
 Install this module individually:
 
 ```sh
-$ npm install @digitransit-search-util/get-label
-```
-
-Or install the digitransit-search-util module that includes it as a function:
-
-```sh
-$ npm install @digitransit-search-util/digitransit-search-util
+$ npm install @digitransit-search-util/digitransit-search-util-get-label
 ```

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@digitransit-search-util/digitransit-search-util-get-label",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "digitransit-search-util get-label module",
   "main": "index.js",
+  "type": "module",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "test": "mocha -r esm test.js",
-    "docs": "node -r esm ../../scripts/generate-readmes"
+    "test": "vitest run --config ../../../config/vitest.config.js \"$PWD/test.js\"",
+    "docs": "node ../../../scripts/workspace-packages/generate-readmes.mjs"
   },
   "repository": {
     "type": "git",
@@ -21,7 +22,7 @@
   "author": "Digitransit Authors",
   "license": "(AGPL-3.0 OR EUPL-1.2)",
   "dependencies": {
-    "@digitransit-search-util/digitransit-search-util-uniq-by-label": "^2.1.3"
+    "@digitransit-search-util/digitransit-search-util-uniq-by-label": "^2.1.4"
   },
-  "gitHead": "939d1d4a44ac0a04872e90b5ef1d8c92559f597c"
+  "gitHead": "3ea16b8aa7ff98fa4d58f72aed40ac0cda27c85f"
 }

package/test.js

@@ -1,12 +1,31 @@
-/* eslint-disable import/no-extraneous-dependencies */
-import { expect } from 'chai';
-import { describe, it } from 'mocha';
-// eslint-disable-next-line no-unused-vars
-import getLabel from '.';
+import { describe, it, expect } from 'vitest';
+import getLabel from './index.js';
 
 describe('Testing @digitransit-search-util/digitransit-search-util-get-label module', () => {
-  it('Checking that true is true', () => {
-    // const retValue = getLabel(param1, param2);
-    expect(true).to.be.equal(true);
+  it('joins name and address for a plain address suggestion', () => {
+    const label = getLabel({
+      layer: 'address',
+      name: 'Mannerheimintie 1',
+      label: 'Mannerheimintie 1, Helsinki',
+    });
+    expect(label).toBe('Mannerheimintie 1, Helsinki');
+  });
+
+  it('returns only the address for a current-position suggestion', () => {
+    const label = getLabel({
+      layer: 'currentPosition',
+      labelId: 'use-own-position',
+      address: 'My location',
+    });
+    expect(label).toBe('My location');
+  });
+
+  it('returns only the name for a favourite place', () => {
+    const label = getLabel({
+      layer: 'favouritePlace',
+      name: 'Home',
+      address: 'Home, Helsinki',
+    });
+    expect(label).toBe('Home');
   });
 });