typescript

Documentation

Overview

Package typescript provides TypeScript/JavaScript extraction for knowledge graphs.

Index

• Constants
• type Extractor
  • func New() *Extractor
  • func (e *Extractor) CanExtract(path string) bool
  • func (e *Extractor) DetectFramework(path string) *provider.FrameworkInfo
  • func (e *Extractor) Extensions() []string
  • func (e *Extractor) ExtractFile(path, baseDir string) ([]*graph.Node, []*graph.Edge, error)
  • func (e *Extractor) Language() string

Constants

const (
	// Language is the canonical name for TypeScript.
	Language = "typescript"

	// NodePrefix is the prefix for all TypeScript node IDs.
	NodePrefix = "ts_"
)

Types

type Extractor

type Extractor struct {
	// contains filtered or unexported fields
}

Extractor implements extract.LanguageExtractor for TypeScript source code.

func New

func New() *Extractor

New creates a new TypeScript extractor.

func (*Extractor) CanExtract

func (e *Extractor) CanExtract(path string) bool

CanExtract returns true for TypeScript/JavaScript files.

func (*Extractor) DetectFramework

func (e *Extractor) DetectFramework(path string) *provider.FrameworkInfo

DetectFramework returns framework information if detected.

func (*Extractor) Extensions

func (e *Extractor) Extensions() []string

Extensions returns TypeScript/JavaScript file extensions.

func (*Extractor) ExtractFile

func (e *Extractor) ExtractFile(path, baseDir string) ([]*graph.Node, []*graph.Edge, error)

ExtractFile extracts nodes and edges from a single TypeScript file.

func (*Extractor) Language

func (e *Extractor) Language() string

Language returns "typescript".