Skip to content

Commit a9a1fc6

Browse files
committed
Update docs
1 parent 9a10b94 commit a9a1fc6

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

README.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,125 +4,221 @@
44

55
### Types
66

7+
#### `Char`
8+
79
newtype Char
810

911

1012
### Type Class Instances
1113

14+
#### `eqChar`
15+
1216
instance eqChar :: Eq Char
1317

18+
#### `ordChar`
19+
1420
instance ordChar :: Ord Char
1521

22+
#### `showChar`
23+
1624
instance showChar :: Show Char
1725

1826

1927
### Values
2028

29+
#### `charString`
30+
2131
charString :: Char -> String
2232

33+
#### `fromCharCode`
34+
2335
fromCharCode :: Number -> Char
2436

37+
#### `toCharCode`
38+
2539
toCharCode :: Char -> Number
2640

2741

2842
## Module Data.String
2943

3044
### Values
3145

46+
#### `charAt`
47+
3248
charAt :: Number -> String -> Maybe Char
3349

50+
#### `charCodeAt`
51+
3452
charCodeAt :: Number -> String -> Maybe Number
3553

54+
#### `count`
55+
3656
count :: (Char -> Boolean) -> String -> Number
3757

58+
#### `drop`
59+
3860
drop :: Number -> String -> String
3961

62+
#### `dropWhile`
63+
4064
dropWhile :: (Char -> Boolean) -> String -> String
4165

66+
#### `fromChar`
67+
4268
fromChar :: Char -> String
4369

70+
#### `fromCharArray`
71+
4472
fromCharArray :: [Char] -> String
4573

74+
#### `indexOf`
75+
4676
indexOf :: String -> String -> Number
4777

78+
#### `indexOf'`
79+
4880
indexOf' :: String -> Number -> String -> Number
4981

82+
#### `joinWith`
83+
5084
joinWith :: String -> [String] -> String
5185

86+
#### `lastIndexOf`
87+
5288
lastIndexOf :: String -> String -> Number
5389

90+
#### `lastIndexOf'`
91+
5492
lastIndexOf' :: String -> Number -> String -> Number
5593

94+
#### `length`
95+
5696
length :: String -> Number
5797

98+
#### `localeCompare`
99+
58100
localeCompare :: String -> String -> Number
59101

102+
#### `null`
103+
60104
null :: String -> Boolean
61105

106+
#### `replace`
107+
62108
replace :: String -> String -> String -> String
63109

110+
#### `singleton`
111+
64112
singleton :: Char -> String
65113

114+
#### `split`
115+
66116
split :: String -> String -> [String]
67117

118+
#### `take`
119+
68120
take :: Number -> String -> String
69121

122+
#### `takeWhile`
123+
70124
takeWhile :: (Char -> Boolean) -> String -> String
71125

126+
#### `toCharArray`
127+
72128
toCharArray :: String -> [Char]
73129

130+
#### `toLower`
131+
74132
toLower :: String -> String
75133

134+
#### `toUpper`
135+
76136
toUpper :: String -> String
77137

138+
#### `trim`
139+
78140
trim :: String -> String
79141

142+
#### `uncons`
143+
80144
uncons :: String -> Maybe { tail :: String, head :: Char }
81145

82146

83147
## Module Data.String.Regex
84148

85149
### Types
86150

151+
#### `Regex`
152+
87153
data Regex :: *
88154

155+
#### `RegexFlags`
156+
89157
type RegexFlags = { unicode :: Boolean, sticky :: Boolean, multiline :: Boolean, ignoreCase :: Boolean, global :: Boolean }
90158

91159

92160
### Type Class Instances
93161

162+
#### `showRegex`
163+
94164
instance showRegex :: Show Regex
95165

96166

97167
### Values
98168

169+
#### `flags`
170+
99171
flags :: Regex -> RegexFlags
100172

173+
#### `match`
174+
101175
match :: Regex -> String -> Maybe [String]
102176

177+
#### `parseFlags`
178+
103179
parseFlags :: String -> RegexFlags
104180

181+
#### `regex`
182+
105183
regex :: String -> RegexFlags -> Regex
106184

185+
#### `renderFlags`
186+
107187
renderFlags :: RegexFlags -> String
108188

189+
#### `replace`
190+
109191
replace :: Regex -> String -> String -> String
110192

193+
#### `replace'`
194+
111195
replace' :: Regex -> (String -> [String] -> String) -> String -> String
112196

197+
#### `search`
198+
113199
search :: Regex -> String -> Number
114200

201+
#### `source`
202+
115203
source :: Regex -> String
116204

205+
#### `split`
206+
117207
split :: Regex -> String -> [String]
118208

209+
#### `test`
210+
119211
test :: Regex -> String -> Boolean
120212

121213

122214
## Module Data.String.Unsafe
123215

124216
### Values
125217

218+
#### `charAt`
219+
126220
charAt :: Number -> String -> Char
127221

222+
#### `charCodeAt`
223+
128224
charCodeAt :: Number -> String -> Number

0 commit comments

Comments
 (0)