feathersjs / docs

[MOVED] Legacy Feathers documentation
https://crow.docs.feathersjs.com/
MIT License
242 stars 532 forks source link

Initial API documentation pages for KoaJS adapter #1529

Closed daffl closed 3 years ago

daffl commented 3 years ago

For https://github.com/feathersjs/feathers/pull/2315

bertho-zero commented 3 years ago

I see that the Koa transporter does not allow to receive an existing app as a second parameter.

And that the express one is not documented.

https://github.com/feathersjs/feathers/blob/a43e7da22b6b981a96d1321736ea9a0cb924fb4f/packages/express/src/index.ts#L24

https://github.com/feathersjs/feathers/blob/a43e7da22b6b981a96d1321736ea9a0cb924fb4f/packages/koa/src/index.ts#L17

daffl commented 3 years ago

I believe they are both documented at https://docs.feathersjs.com/api/express.html#express-2 and https://dove.docs.feathersjs.com/api/koa.html#koa-2 it should work pretty much the same (although Koa needed the Object assignment the other way around for inheritance reasons).

bertho-zero commented 3 years ago

I don't see any mention of the second argument to use an existing express or koa app, the links you send me show the signature with no arguments.

daffl commented 3 years ago

Oooh... sorry I forgot about that, that is a good point.

daffl commented 3 years ago

Added to the docs via https://github.com/feathersjs/docs/commit/76a8af41cf8ed6a6a4514470abcbc5314fb9f527