koajs / rewrite Goto Github PK

View Code? Open in Web Editor NEW

100.0 6.0 13.0 19 KB

URL rewriting middleware

License: MIT License

JavaScript 100.00%

rewrite's Introduction

koa-rewrite

URL rewrite middleware for koa.

Notice: koa-rewrite@2+ supports koa@2, if you want to use this module with koa@1, please use koa-rewrite@1.

Installation

$ npm install koa-rewrite

Examples

Rewrite using a regular expression, rewriting /i123 to /items/123.

app.use(rewrite(/^\/i(\w+)/, '/items/$1'));

Rewrite using route parameters, references may be named or numeric. For example rewrite /foo..bar to /commits/foo/to/bar:

app.use(rewrite('/:src..:dst', '/commits/$1/to/$2'));
app.use(rewrite('/:src..:dst', '/commits/:src/to/:dst'));

You may also use the wildcard * to soak up several segments, for example /js/vendor/jquery.js would become /public/assets/js/vendor/jquery.js:

app.use(rewrite('/js/(.*)', '/public/assets/js/$1'));

Debugging

Use the DEBUG environment variable with "koa-rewrite":

koa-rewrite rewrite /i123 -> /items/123 +762ms
koa-rewrite rewrite /i321 -> /items/321 +9s
koa-rewrite rewrite /i123 -> /items/123 +5s

License

MIT

rewrite's People

Contributors

Stargazers

Watchers

Forkers

juliangruber yanickrochon macalinao lwsjs asa-taka chenyuan8059 jinphen qubaish twobear 3imed-jaberi jiyulongxu isabella232 iq-scm

rewrite's Issues

Old CI pipeline

Old CI pipeline // don't exist any test !!

Missing Lint

Missing Lint !!

support rewrite for qs

Is it acceptable to support rewrite from qs?

Such as

/items?id=1

/items/1

If so, I'll submit a PR.

Missing LICENSE !

Missing LICENSE !!

support rewrite to headers && query

Missing Coverage

Missing Test Coverage !

update dependency: path-to-regexp

This will be a broken change!

Query parameters are missing after a rewrite

I am using koa-rewrite ver 3.0.0. I specified the following in my app:

app.use(rewrite(/^\/p\/didit/, '/p/customers/section_id/didits'));

After the rewrite is executed, all of the query parameters are gone. I traced it down to the following line in index.js of koa-rewrite module:

ctx.url = dst.replace(/\$(\d+)|(?::(\w+))/g, (_, n, name) => {
        if (name) return m[map[name].index + 1];
        return m[n];
      });

I am not sure why setting the url would cause the query parameters to be gone.

/experience/testing-main?ddate='10-10-10' 
to
/some-random-url?ddate=$1

Please advise if its possible.

Thanks

make master branch compatible with koa@1

koajs/koa#603

app.use() requires a generator function

I am using Koa@1 and koa-rewrite@1 and try to implement functionality like this.

rewritelogic.js

const rewrite = require('koa-rewrite');
function rewriteLogic(){
  rewrite('/english/experience/dev1', '/english/experience/dev');
}

module.exports = {
  rewriteLogic,
}

And then use this file in my app.js

app.use(rewrite.rewriteLogic)

But I am facing this error

AssertionError [ERR_ASSERTION]: app.use() requires a generator function

Can you help me on this ?

I removed this error by providing generator function but then rewrite functionality did not worked.

const rewrite = require('koa-rewrite');
function* rewriteLogic(next){
  rewrite('/english/experience/dev1', '/english/experience/dev');
  yield next;
}
module.exports = {
  rewriteLogic,
}