Provide documentation about arguments

[abelosorio]

No description provided.

[cyrilchapon]

IMHO, even if your object args is interesting, this library shouldn't integrate its own convention, but rather follow Sequelize.queryInterface convention (args inline instead of wrapped inside an object)

[cyrilchapon]

Thus, for example, renameEnum should be of form

renameEnum(
  'before',
  'after',
  { transaction: t }
)

[abelosorio]

Yes, I agree. I think we should find a way for this package to extend Sequelize in a nice way. In other packages I used the Decorator Pattern and I liked it.

Let me know your thoughts.

Thanks

[cyrilchapon]

Decorate sequelize with a global decorator factory

const SequelizeEnum = require('sequelize-replace-enum-postgres')

const sequelizeEnum = SequelizeEnum(sequelize)
// Or POO style
// const sequelizeEnum = new SequelizeEnum(sequelize)

sequelizeEnum.replaceEnum('before', 'after', {/* replaceEnumAndSequelizeOptions*/})
sequelizeEnum.dropEnum('before', {/* dropEnumAndSequelizeOptions*/})
// etc...

Curry each call FP style

const sequelizeEnum = require('sequelize-replace-enum-postgres')

sequelizeEnum.replaceEnum(sequelize)('before', 'after', {/* replaceEnumAndSequelizeOptions*/})
sequelizeEnum.dropEnum(sequelize)('before', {/* dropEnumAndSequelizeOptions*/})
// etc...

[abelosorio]

Hey @cyrilchapon , sorry for the late reply.

What about wrapping the queryInterface? Since all the methods to alter the database's structure are available within queryInterface I think it makes sense to put replaceEnum inside it too.

What do you think?

[cyrilchapon]

Partly fixed by #31