Limit methods: raise · StartupBuilder

Reference for Limit, one group of Limit methods.

Limit.raise

Raise lifts a Limit after an Approval allows it, and the Action that waited on it proceeds. Verb page.

TypeScript

interface LimitVerbs {
  raise(input: LimitRaiseInput, options?: SB.CallOptions): SB.Call<Limit>
}

Inputs

Input	Type	Required	Description
`limit`	Limit	required	The Limit to lift.
`to`	`json`	required	The new amount, count or rate.

Returns

Output	Type	Required	Description
`limit`	Limit	required	The raised Limit.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const limit = await $.Limit.raise({ limit: 'limit_UWHXYVKsJB', to: {} })