kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

export getAbsoluteFSPath method instead of property

Browse Source
This commit is contained in:
Dylan
2017-06-12 22:21:47 -07:00
parent df149c543b
commit 3311f3e95f
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
swagger-ui-dist-package/README.md
View File

@@ -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
```

4
swagger-ui-dist-package/absolute-path.js
View File

@@ -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

8
test/swagger-ui-dist-package/absolute-path.js
View File

@@ -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)
})
})
})