forinvest-cli
    Preparing search index...

    Interface IDefinitionsController

    interface IDefinitionsController {
        getAll(): Definition[];
        getByCode(code: string): Definition;
        getByDomain(domain: DefinitionDomain): Definition[];
        getByExchange(exchange: DefinitionExchange): Definition[];
        getById(id: string): Definition;
        getByLegacyCode(code: string): Definition;
        getByLocalCode(code: string): Definition;
        getDefinitionAvailabilities(
            definition: Definition,
        ): DefinitionAvailabilities;
        getDefinitionByQuery(query: any[]): Definition[];
        getDefinitionByQueryFromAPI(
            definitionQuery: any[],
            definitionLocale: DefinitionLocale,
        ): Promise<void | Definition[]>;
        getDefinitionsForSelector(query: any[], group: string): Definition[];
        searchDefinition(search: string): Definition[];
        setAllDefinition(definitionLocale: DefinitionLocale): Promise<void>;
        setDefinition(
            definitionId: string,
            definitionLocale: DefinitionLocale,
        ): void;
        setDefinitionByDomain(
            domain: string,
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        setDefinitionByQuery(
            definitionQuery: any[],
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        setDefinitionByQueryWithFilter(
            definitionQuery: any[],
            definitionLocale: DefinitionLocale,
            fieldFilter?: string[],
        ): Promise<void>;
        setDefinitionByStaticData(definitions: Definition[]): void;
        setDefinitions(
            definitionsIds: string[],
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        tradingViewSearch(params: any, locale?: string): any[];
        tradingViewSymbolInfo(params: any, locale?: string): any[];
    }
    Index

    Methods

    getAll getByCode getByDomain getByExchange getById getByLegacyCode getByLocalCode getDefinitionAvailabilities getDefinitionByQuery getDefinitionByQueryFromAPI getDefinitionsForSelector searchDefinition setAllDefinition setDefinition setDefinitionByDomain setDefinitionByQuery setDefinitionByQueryWithFilter setDefinitionByStaticData setDefinitions tradingViewSearch tradingViewSymbolInfo

    Methods

    • Returns Definition[]

      definitions

    • Parameters

      • code: string

        definition code

      Returns Definition

      definition

    • Parameters

      • id: string

        : definition id

      Returns Definition

    • Parameters

      • code: string

        definition legacyCode

      Returns Definition

      definition

    • Parameters

      • code: string

        definition code

      Returns Definition

      definition

    • Parameters

      • query: any[]

        query example

      Returns Definition[]

      definition

    • get definition by query from API with

      Parameters

      • definitionQuery: any[]

        definitionQuery example [{exchange: 'BIST', type: 'E'}]

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns Promise<void | Definition[]>

    • Parameters

      • query: any[]

        query

      • group: string

        group

      Returns Definition[]

      definition

    • Parameters

      • search: string

        : search

      Returns Definition[]

      definition

    • Parameters

      Returns Promise<void>

    • Parameters

      • definitionId: string

        definition id

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns void

    • Parameters

      Returns Promise<void>

    • Parameters

      • definitionQuery: any[]

        definitionQuery example [{exchange: 'BIST', type: 'E'}]

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns Promise<void>

    • Parameters

      • definitionQuery: any[]

        definitionQuery example [{exchange: 'BIST', type: 'E'}]

      • definitionLocale: DefinitionLocale

        definitionLocale

      • OptionalfieldFilter: string[]

        fieldFilter example ['_id', 'code']

      Returns Promise<void>

    • Parameters

      Returns void

    • Parameters

      • definitionsIds: string[]

        definitionsIds

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns Promise<void>

    • Parameters

      • params: any

        {exchange: string, limit: number, query: string, type: string}

      • Optionallocale: string

      Returns any[]

      result list of definitions

    • Parameters

      • params: any

        {exchange: string, limit: number, query: string, type: string}

      • Optionallocale: string

      Returns any[]

      result list of definitions

    Settings

    Member Visibility

    On This Page

    Methods