TypeError: VerEx.sanitize is not a function

[amoshydra]

Current Problem

sanitize is not available as a static function as documented in here https://verbalexpressions.github.io/JSVerbalExpressions/VerbalExpression/utilities

VerEx.sanitize is undefined

Reproduce link: https://codesandbox.io/s/0437l1r9jl

Expected behaviour

I was expected to use VerEx sanitize function like this

const filePath = '/path/to/file'
const sanitized = VerEx.sanitize(filePath)
sanitized.source === ///path//to//file/.source

Environment

Version tested:

• v0.3.0
• https://github.com/shreyasminocha/JSVerbalExpressions/commit/5ca909d147ec9c9f61db9de30f1f3250ccf79ab3

[shreyasminocha]

This is because the sanitize method is a static method of the VerbalExpression class. However, we are export only an instance of VerbalExpression (per this). Not sure what the way forward is.

[amoshydra]

Noted.

---

Would an implementation like this make sense?

function VerEx() { // eslint-disable-line no-unused-vars
    return new VerbalExpression();
}
VerEx.sanitize = VerbalExpression.sanitize;

Related: https://github.com/shreyasminocha/JSVerbalExpressions/blob/5ca909d1/VerbalExpressions.js#L482-L484

[shreyasminocha]

If there'x enough use-case, LGTM; @jehna, @ionutvmi?

[jehna]

Hmm. The documentation actually points to VerbalExpressions.sanitize (there's a typo, it should be VerbalExpression.sanitize). At the moment we don't expose the main VerbalExpression class at all to the public.

I checked the previous versions (0.2.0, 0.2.1 and 0.1.2), and seems that we haven't exposed the main class at any point 🤔

Edit: Side note: So it kinda does work as intended, but you'll need to dig up the hidden VerbalExpression class by doing something like: VerEx().constructor.sanitize

What did work in 0.2.x however was the format VerEx().sanitize(input).

I'd propose that we'd think this from the public API's standpoint: I'd think the most logical way would be to use:

import { sanitize } from 'verbal-expressions'

sanitize(input)

We could then use the es import/exports to export the sanitize function:

export function sanitize(...) {...}

...and use the function instead of the static VerbalExpression.sanitize in the code. How does this sound?

[shreyasminocha]

@jehna Yeah, I noticed the typo too (will open a PR).

Sounds good to me, but it's just that es import/export are annoying to transpile. Even with babel-plugin-transform-es2015-modules-umd, there's the issue of having to add .default at the end of the exported global when using the transpiled version. babel-plugin-add-module-exports doesn't work with anything except CommonJS. I might create my own babel plugin to fix this, but till then we'll have to do it the ES5 way.

[jehna]

@shreyasminocha alright, using VerEx.sanitize = VerbalExpression.sanitize; sounds good 🙂👍 Simple and works!

[shreyasminocha]

181 fixes this.