hakonrossebo / elmdocs / ElmDocs

A helper package to be used in elm REPL. By importing this package you can search all available Elm packages directly from the REPL.

Usage

help : List String

Get available functions to run when using REPL

import ElmDocs exposing (..)
help

getPackageInfo : String -> FindPackageResult

Get a list of all modues in a package

import ElmDocs exposing (..)
getPackageInfo "elm/core"

getPackageModuleValues : String -> String -> FindPackageResult

Get a list of all values for a specific module in a package run getPackageInfo "packageVendor/packageName" first to get a list of available modules

import ElmDocs exposing (..)
getPackageModuleValues "elm/core" "List"

search : String -> ( String, List Location )

Search all package module values/unions/aliases

import ElmDocs exposing (..)
search "sqrt"

searchType : String -> ( String, List Location )

Search all package module values/unions/aliases for a type signature

import ElmDocs exposing (..)
searchType "a - a"
searchType "Basics.Int -> Basics.Float"

getAllPackageModules : List FindPackageResult

Get a list of all package modules - Generates a long list in REPL

import ElmDocs exposing (..)
getAllPackageModules