diff --git a/swagger-ui-dist-package/README.md b/swagger-ui-dist-package/README.md index c5165765..3737c8ae 100644 --- a/swagger-ui-dist-package/README.md +++ b/swagger-ui-dist-package/README.md @@ -8,13 +8,13 @@ Use `swagger-ui` instead, if you'd like to have npm install dependencies for you `SwaggerUIBundle` and `SwaggerUIStandalonePreset` can be imported: ```javascript - import { SwaggerUIBundle, SwaggerUIStandalonePreset } from 'swagger-ui-dist' + import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist" ``` -To get an absolute path to this directory for static file serving, use the exported `absolutePath` property: +To get an absolute path to this directory for static file serving, use the exported `getAbsoluteFSPath` method: ```javascript -const swaggerUiAssetPath = require('swagger-ui-dist').absolutePath; +const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath // then instantiate server that serves files from the swaggerUiAssetPath ``` diff --git a/swagger-ui-dist-package/absolute-path.js b/swagger-ui-dist-package/absolute-path.js index 650e7dbf..26a3cc01 100644 --- a/swagger-ui-dist-package/absolute-path.js +++ b/swagger-ui-dist-package/absolute-path.js @@ -8,7 +8,7 @@ const getAbsoluteFSPath = () => { if (typeof module !== "undefined" && module.exports) { return require("path").resolve(__dirname) } - return "Error! absolutePath only available when running in NodeJS" + throw new Error('getAbsoluteFSPath can only be called within a Nodejs environment'); } -module.exports = getAbsoluteFSPath() +module.exports = getAbsoluteFSPath diff --git a/test/swagger-ui-dist-package/absolute-path.js b/test/swagger-ui-dist-package/absolute-path.js index aba27933..252a298a 100644 --- a/test/swagger-ui-dist-package/absolute-path.js +++ b/test/swagger-ui-dist-package/absolute-path.js @@ -1,13 +1,13 @@ /* eslint-env mocha */ import expect from "expect" import path from "path" -import absolutePath from "../../swagger-ui-dist-package/absolute-path" +import getAbsoluteFSPath from "../../swagger-ui-dist-package/absolute-path" describe("swagger-ui-dist", function(){ - describe("absolutePath", function(){ - it("has absolute path", function(){ + describe("getAbsoluteFSPath", function(){ + it("returns absolute path", function(){ const expectedPath = path.resolve(__dirname, "../../swagger-ui-dist-package") - expect(absolutePath).toEqual(expectedPath) + expect(getAbsoluteFSPath()).toEqual(expectedPath) }) }) })