Files
Marcus Andersson 6bc369629d Docs: adding first version of the auto-generated packages API docs. (#22107)
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.
2020-02-26 10:03:53 +01:00

2.3 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "CSVReader" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

CSVReader class

Signature

export declare class CSVReader 

Import

import { CSVReader } from '@grafana/data';

Constructors

Constructor Modifiers Description
constructor(options) Constructs a new instance of the CSVReader class

Properties

Property Modifiers Type Description
callback CSVParseCallbacks
config CSVConfig
current MutableDataFrame
data MutableDataFrame[]
state ParseState

Methods

Method Modifiers Description
readCSV(text)

constructor(options)

Constructs a new instance of the CSVReader class

Signature

constructor(options?: CSVOptions);

Parameters

Parameter Type Description
options CSVOptions

callback property

Signature

callback?: CSVParseCallbacks;

config property

Signature

config: CSVConfig;

current property

Signature

current: MutableDataFrame;

data property

Signature

data: MutableDataFrame[];

state property

Signature

state: ParseState;

readCSV method

Signature

readCSV(text: string): MutableDataFrame[];

Parameters

Parameter Type Description
text string

Returns:

MutableDataFrame[]