Explain how to require @graphile/postgis in library mode with CommonJS

[hengnee]

Hi, I'm not sure if this is the right place to ask such a question but I do apologies in advance.

but doing the following in my code:

const PostgisPlugin =  require("@graphile/postgis");
...
const postgraphileOpt = {
  watchPg: true,
  retryOnInitFail: true,
  graphiql: true,
  enhanceGraphiql: true,
  graphiqlRoute: "/schema",
  enableCors: true,
  disableQueryLog: true,
  appendPlugins: [ConnectionFilterPlugin, PostgisPlugin]
};

produced this error:

$ Error: Option 'appendPlugins' should be an array of functions, found 'object'  at index 1 ...

May I know if I'm doing it completely wrong or should I not have used it within the library but in the CLI instead?

[benjie]

Ah, this is because you're using CommonJS; to solve it, change the appendPlugins line to:

  appendPlugins: [
    ConnectionFilterPlugin,
    PostgisPlugin.default || PostgisPlugin,
  ]

Thanks!

[crooy]

Would setting esModuleInterop not solve this?

[nodesocket]

Just spent 10 minutes trying to figure this out. Would be nice to add to the README.md.

const extPostgis = require('@graphile/postgis');

...
appendPlugins: [extPgSimplifyInflector, extPostgis.default || extPostgis],
...

[benjie]

PR to README welcome 👍