Algorithm
An algorithm is a type of resource that holds only a functions property.
ts
export type AlgorithmStructure = {
functions?: Record<string, (...args: any[]) => any>
}
export type Algorithm = () => AlgorithmStructure|Promise<AlgorithmStructure>Declaration and use cases
To declare an algorithm simply provide a function that returns an object with a functions property. See more about functions here. For the sake of exemplification let's create a ficticious multimedia processing algorithm and call it mediaProcessing:
typescript
export default () => ({
functions: {
processImage: (payload: ImageProcessingPayload, context: Context) => {
// do some kind of work
},
processVideo: (payload: VideoProcessingPayload, context: Context) => {
// same as above but with a video instead
},
}
})Now we have a set of functions that lives under the mediaProcessing algorithm. If we wanted to add some kind of rate limiting on both functions we could do that easily:
typescript
export const accessControl = defineAccessControl<Collections, Algorithms>()({
roles: {
guest: {
capabilities: {
mediaProcessing: {
grantEverything: true
}
}
}
},
})({
async call(context) {
if(context.resourceName === 'mediaProcessing') {
await context.limitRate({
// ...
})
}
}
})