bucketModifyItems()
Home > @gooddata/sdk-model > bucketModifyItems
bucketModifyItems() function
Creates a new bucket by modifying items of the provided input bucket.
Signature:
export declare function bucketModifyItems(bucket: IBucket, modifications?: BucketItemModifications): IBucket;
Parameters
| Parameter | Type | Description |
|---|---|---|
| bucket | IBucket | bucket in which all items are applied the modification function |
| modifications | BucketItemModifications | (Optional) the modification to apply to the bucket items |
Returns:
new instance of bucket with modified bucket items
Remarks
Each item from the input bucket will be dispatched to the modification function and the result of the modification will be included in the new bucket.
Note: it is valid for the modification function to just return the original item. In that case the item will be included in the bucket without modification.