@tsed/platform-cache
v8.25.0
Published
Platform cache module for Ts.ED Framework
Readme
A package of Ts.ED framework. See website: https://tsed.devdocs/cache.html
Installation
npm install --save @tsed/platform-cacheForce refresh
Send the header Cache-Control: no-cache (or set it directly on the PlatformContext) to bypass
PlatformCacheInterceptor for a single request. This is handy when you want a fresh response without wiping the cache.
You can override or extend this behavior with the byPass option on @UseCache:
- Service methods default to
byPass: false, so they always consult the cache unless you explicitly returntruefrom your predicate. - HTTP endpoints default to
byPass: "no-cache", which automatically honours theCache-Control: no-cacheheader for one-off refreshes. - Provide a function (
byPass: (args, $ctx) => boolean) to build custom strategies (e.g., bypass for admins or based on payload).
Contributors
Please read contributing guidelines here.
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
License
The MIT License (MIT)
Copyright (c) 2016 - 2022 Romain Lenzotti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
