const utilities = new KojiBackend.Utilities({ res });Provides utility methods for improving the performance and functionality of your Koji app.
Instantiates the Utilities class.
config - BackendConfigurationInput, Configuration information for the Koji app.
const utilities = new KojiBackend.Utilities({ res });Regenerates thumbnails for the Koji app.
Promise<Void>
await utilities.regenerateThumbnails();Source: backend/utilities/index.ts#L114
Unfreezes a response that has been frozen with an x-koji-freeze-key header.
Freeze Keys enable you to cache and purge content in Koji’s CDN, dramatically improving the speed and reliability of backend data requests in your Koji apps.
Make a request directly to the Koji CDN and receive a cached response, instead of waiting for the backend to warm up and serve the request.
Use the x-koji-freeze-key header to instruct the CDN to serve a cached
response and KojiBackend.Utilities.unfreeze to reset the cache. The
platform automatically handles remix scoping, so you can maintain one set
of logic in your templates.
Note that Freeze Keys are useful when responses should be cached
indefinitely, until some manual action triggers a purge (e.g., a
leaderboard for a game should be cached until a new score is added, at
which point it is unfrozen and regenerated). If you wish to implement
simple time-based caching at the CDN level (i.e., clients do not cache
responses, but they are cached in the CDN until expiry), use the
x-koji-cache-control header on the response, which functions the same way
as the standard Cache-Control HTTP header.
key - String, Key used to freeze the response.
Promise<Void>
app.get('/loadPosts', async (req, res) => {
const posts = [{ value: 'postValue' }];
res.setHeader('x-koji-freeze-key', 'posts');
res.status(200).json({
posts,
});
});
app.post('/update', async (req, res) => {
// Update some data in the database
// await db.update....
// Unfreeze. The next request to /loadPosts will hit the server and get
// a fresh list of posts, which will then be frozen until unfreeze is
// called again.
await utilities.unfreeze('posts');
res.sendStatus(200);
});Source: backend/utilities/index.ts#L93
Configuration information for the Koji app.
projectId - String (Optional), Unique identifier for the Koji app. Will override data passed through `res`.
projectToken - String (Optional), Secret key for the Koji app. Will override data passed through `res`.
res - Response (Optional), Express response object. Used in conjunction with middleware to scope environment variables for customized versions of the original Koji app. For the original definition see [[https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/express/index.d.ts#L127 | @types/express]].