• English
  • LimitBuilder

    Data limit builder for setting and getting the current limit.

    Methods

    constructor

    Constructor

    Definition:

    constructor(_doc: Y.Doc, dsl: Y.Map<any>)

    Parameters:

    ParameterTypeDescription
    _docY.Doc-
    dslY.Map-

    observe

    Listens for limit changes, returns an unsubscribe function.

    Definition:

    observe(callback: ObserveCallback): () => void

    Returns: () => void

    Parameters:

    ParameterTypeDescription
    callbackObserveCallback- Callback function

    setLimit

    Sets the limit.

    Definition:

    setLimit(limit: number)

    Parameters:

    ParameterTypeDescription
    limitnumber- Data limit

    getLimit

    Gets the current limit.

    Definition:

    getLimit(): number | undefined

    Returns: number \| undefined

    toJSON

    Exports to JSON.

    Definition:

    toJSON(): number | undefined

    Returns: number \| undefined