Interface UtilsContext

interface UtilsContext {
    addMarkerDown(text: string, name: string): void;
    addMarkerUp(text: string, name: string): void;
    marketAfterMinutes(): number;
    marketAfterMinutesGreaterThen(number: number): boolean;
    marketAfterMinutesGreaterThenOrEqualTo(number: number): boolean;
    marketAfterMinutesLessThen(number: number): boolean;
    marketAfterMinutesLessThenOrEqualTo(number: number): boolean;
    marketIsClosed(): boolean;
    marketIsOpen(): boolean;
    marketNextCloseMinutes(): number;
    marketNextCloseMinutesGreaterThen(number: number): boolean;
    marketNextCloseMinutesGreaterThenOrEqualTo(number: number): boolean;
    marketNextCloseMinutesLessThen(number: number): boolean;
    marketNextCloseMinutesLessThenOrEqualTo(number: number): boolean;
    marketNextOpenMinutes(): number;
    marketNextOpenMinutesGreaterThen(number: number): boolean;
    marketNextOpenMinutesGreaterThenOrEqualTo(number: number): boolean;
    marketNextOpenMinutesLessThen(number: number): boolean;
    marketNextOpenMinutesLessThenOrEqualTo(number: number): boolean;
    resetMarkers(count: number, upper: number): void;
    webhook(id: string, props: WebhookProps): boolean;
}

Methods

addMarkerDown addMarkerUp marketAfterMinutes marketAfterMinutesGreaterThen marketAfterMinutesGreaterThenOrEqualTo marketAfterMinutesLessThen marketAfterMinutesLessThenOrEqualTo marketIsClosed marketIsOpen marketNextCloseMinutes marketNextCloseMinutesGreaterThen marketNextCloseMinutesGreaterThenOrEqualTo marketNextCloseMinutesLessThen marketNextCloseMinutesLessThenOrEqualTo marketNextOpenMinutes marketNextOpenMinutesGreaterThen marketNextOpenMinutesGreaterThenOrEqualTo marketNextOpenMinutesLessThen marketNextOpenMinutesLessThenOrEqualTo resetMarkers webhook

Methods

addMarkerDown

  • addMarkerDown(text, name): void

  • Add Up marker on map

    Parameters

    • text: string
    • name: string

    Returns void

    Example

    utils.addMarkerDown('Sell');

addMarkerUp

  • addMarkerUp(text, name): void

  • Add Up marker on map

    Parameters

    • text: string
    • name: string

    Returns void

    Example

    utils.addMarkerUp('Buy');

marketAfterMinutes

  • marketAfterMinutes(): number

  • Used to check the elapsed time after the market is closed. This method returns the number of minutes that have passed since the market closed, based on the current time. This method is useful when the user wants to apply a time-based strategy for trading in the extended market hours. This method requires a number as a parameter, which indicates how many minutes to add to the market closing time. For example, marketAfterMinutes(5) returns the number of minutes that have passed since 5 minutes after the market closed.

    Returns number

    Example

    tick = (i, bot, utils) => {
       if(marketAfterMinutes(5)){
       ...
       }
     }

marketAfterMinutesGreaterThen

  • marketAfterMinutesGreaterThen(number): boolean

  • Used to compare the elapsed time after the market closes with a given number. This method returns true if the number of minutes that have passed since the market closed is greater than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time passed after the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the elapsed time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketAfterMinutesGreaterThen(5)){
       ...
       }
     }

marketAfterMinutesGreaterThenOrEqualTo

  • marketAfterMinutesGreaterThenOrEqualTo(number): boolean

  • Used to compare the elapsed time after the market closes with a given number. This method returns true if the number of minutes that have passed since the market closed is greater than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time passed after the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the elapsed time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketAfterMinutesGreaterThenOrEqualTo(5)){
       ...
       }
     }

marketAfterMinutesLessThen

  • marketAfterMinutesLessThen(number): boolean

  • Used to compare the elapsed time after the market closes with a given number. This method returns true if the number of minutes that have passed since the market closed is less than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time passed after the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the elapsed time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketAfterMinutesLessThen(5)){
       ...
       }
     }

marketAfterMinutesLessThenOrEqualTo

  • marketAfterMinutesLessThenOrEqualTo(number): boolean

  • Used to compare the elapsed time after the market closes with a given number. This method returns true if the number of minutes that have passed since the market closed is less than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time passed after the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the elapsed time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketAfterMinutesLessThenOrEqualTo(5)){
       ...
       }
     }

marketIsClosed

  • marketIsClosed(): boolean

  • Used to check if the market is closed or not. This method returns true if the current time is outside of the regular market hours, and false otherwise. This method is useful when the user wants to apply a different strategy for trading in the extended market hours. This method does not require any parameters.

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketIsClosed()){
       ...
       }
     }

marketIsOpen

  • marketIsOpen(): boolean

  • Used to check if the market is open or not. This method returns true if the current time is within the regular market hours, and false otherwise. This method is useful when the user wants to apply a different strategy for trading in the regular market hours. This method does not require any parameters.

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketIsOpen()){
       ...
       }
     }

marketNextCloseMinutes

  • marketNextCloseMinutes(): number

  • Used to check the remaining time until the market closes. This method returns the number of minutes that are left until the market closes, based on the current time. This method is useful when the user wants to apply a time-based strategy for trading before the market closes.

    Returns number

    Example

    tick = (i, bot, utils) => {
       if(marketNextCloseMinutes(5)){
       ...
       }
     }

marketNextCloseMinutesGreaterThen

  • marketNextCloseMinutesGreaterThen(number): boolean

  • Used to compare the remaining time until the market closes with a given number. This method returns true if the number of minutes that are left until the market closes is greater than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextCloseMinutesGreaterThen(5)){
       ...
       }
     }

marketNextCloseMinutesGreaterThenOrEqualTo

  • marketNextCloseMinutesGreaterThenOrEqualTo(number): boolean

  • Used to compare the remaining time until the market closes with a given number. This method returns true if the number of minutes that are left until the market closes is greater than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextCloseMinutesGreaterThenOrEqualTo(5)){
       ...
       }
     }

marketNextCloseMinutesLessThen

  • marketNextCloseMinutesLessThen(number): boolean

  • Used to compare the remaining time until the market closes with a given number. This method returns true if the number of minutes that are left until the market closes is less than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextCloseMinutesLessThen(5)){
       ...
       }
     }

marketNextCloseMinutesLessThenOrEqualTo

  • marketNextCloseMinutesLessThenOrEqualTo(number): boolean

  • Used to compare the remaining time until the market closes with a given number. This method returns true if the number of minutes that are left until the market closes is less than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the market closes. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextCloseMinutesLessThenOrEqualTo(5)){
       ...
       }
     }

marketNextOpenMinutes

  • marketNextOpenMinutes(): number

  • Used to check the remaining time until the next market open. This method returns the number of minutes that are left until the next market opens, based on the current time. This method is useful when the user wants to apply a time-based strategy for trading before the next market opens.

    Returns number

    Example

    tick = (i, bot, utils) => {
       if(marketNextOpenMinutes(5)){
       ...
       }
     }

marketNextOpenMinutesGreaterThen

  • marketNextOpenMinutesGreaterThen(number): boolean

  • Used to compare the remaining time until the next market opens with a given number. This method returns true if the number of minutes that are left until the next market opens is greater than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the next market opens. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextOpenMinutesGreaterThen(5)){
       ...
       }
     }

marketNextOpenMinutesGreaterThenOrEqualTo

  • marketNextOpenMinutesGreaterThenOrEqualTo(number): boolean

  • Used to compare the remaining time until the next market opens with a given number. This method returns true if the number of minutes that are left until the next market opens is greater than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the next market opens. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextOpenMinutesGreaterThenOrEqualTo(5)){
       ...
       }
     }

marketNextOpenMinutesLessThen

  • marketNextOpenMinutesLessThen(number): boolean

  • Used to compare the remaining time until the next market opens with a given number. This method returns true if the number of minutes that are left until the next market opens is less than the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the next market opens. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextOpenMinutesLessThen(5)){
       ...
       }
     }

marketNextOpenMinutesLessThenOrEqualTo

  • marketNextOpenMinutesLessThenOrEqualTo(number): boolean

  • Used to compare the remaining time until the next market opens with a given number. This method returns true if the number of minutes that are left until the next market opens is less than or equal to the given number, and false otherwise. This method is useful when the user wants to execute a conditional action based on the time left until the next market opens. This method requires a number as a parameter, which indicates how many minutes to compare with the remaining time.

    Parameters

    • number: number

    Returns boolean

    Example

    tick = (i, bot, utils) => {
       if(marketNextOpenMinutesLessThenOrEqualTo(5)){
       ...
       }
     }

resetMarkers

  • resetMarkers(count, upper): void

  • Resset markers to count if length upper

    Parameters

    • count: number
    • upper: number

    Returns void

    Example

    utils.resetMarkers(50, 100);

webhook

  • webhook(id, props): boolean

  • Make webhook

    Parameters

    Returns boolean

    Example

    utils.webhook({
       url: 'https://example.com/webhook',
       type: 'post',
       data: {
         message: 'Hello, World!',
       },
       debounce: 1000,
     });

Settings

Member Visibility

On This Page

Methods