feat: add job name formatter

[felixmosh]

closes #349

[bugs181]

Definitely a lot cleaner than the solution I was working on!

[bugs181]

Whoopsie. It appears that when no formatter is available, the whole jobProps object is passed into the name property. Unless I'm missing something.

Fix for this:

const nameProp = queue.format('name', jobProps)

return {
    name: (typeof nameProp === 'string') ? nameProp : jobProps.name,
}

Not the cleanest solution, but keeps the UI from crashing on my end.

@felixmosh can you confirm?

[felixmosh]

Ha, you are correct :|

[bugs181]

The above fix would also take into account of the user accidentally passing the wrong info back. The name prop will always be guaranteed to be a string.

[felixmosh]

If a user passes a formatter function, he "takes" responsibility on himself, no? ;]

If we encounter many issues on it, I will add the check :]

[bugs181]

That is true; but sanitization and type safety is never a bad thing. Why else do we use tools like TypeScript? ;)

The only alternative I can think would be to overload format with a fallbackData option, then we would pass that data along.

return {
  name: queue.format('name', jobProps, jobProps.name)
}

public format(field: FormatterField, data: any, fallbackData: any): any {
  return typeof this.formatters[field] === 'function' ? this.formatters[field](data) : fallbackData || data;
}

[felixmosh]

Yeah, I've thought about the same thing 😅
Actually, it is an easy thing to make TS check this

[bugs181]

Fair points. I still recommend doing something other than passing the whole jobProps into the name prop. Just for future proofing code.

[felixmosh]

I've used your suggestion, b306477

[bugs181]

Very nice. Thanks for all your hard work. I hope to help contribute more in the future. Hopefully without being a thorn in your side haha.