Liking cljdoc? Tell your friends :D

wreck.api

The public API of the library. Note that all methods will throw if the resulting regular expression is syntactically invalid.

The public API of the library.  Note that all methods will throw if the
resulting regular expression is syntactically invalid.
raw docstring

='clj/s

(=' _)
(=' re1 re2)
(=' re1 re2 & more)

Equality for regexes, defined by having equal String representations. This means that equivalent regexes (e.g. #"..." and #".{3}" will not be considered equal.

Note: this is only needed in ClojureJVM (ClojureScript correctly implements equals on regexes).

Equality for regexes, defined by having equal `String` representations.  This
means that _equivalent_ regexes (e.g. `#"..."` and `#".{3}"` will _not_ be
considered equal.

Note: this is only needed in ClojureJVM (ClojureScript correctly implements
equals on regexes).
sourceraw docstring

altclj/s

(alt & res)

Returns a regex that will match any one of res, via alternation. Does not perform any grouping of the elements in res - for that use [alt-grp].

Returns a regex that will match any one of `res`, via alternation. Does not
perform any grouping of the elements in `res` - for that use [alt-grp].
sourceraw docstring

alt-grpclj/s

(alt-grp & res)

[grp] on each element in res, then [alt].

[grp] on each element in `res`, then [alt].
sourceraw docstring

and'clj/s

(and' a b)
(and' a b s)

Returns an 'and' regex that will match a and b in any order, and with the separator regex (if provided) between them. This is implemented as ASB|BSA, which means that A and B must be distinct (must not match each other). Does not perform any grouping, ether on a, b, or s - for that use [and-grp].

Returns an 'and' regex that will match `a` and `b` in any order, and with the
`s`eparator regex (if provided) between them.  This is implemented as
`ASB|BSA`, which means that A and B must be distinct (must not match each
other).  Does not perform any grouping, ether on `a`, `b`, or `s` - for that
use [and-grp].
sourceraw docstring

and-grpclj/s

(and-grp a b)
(and-grp a b s)

[grp] around a, b and s, then [and'].

[grp] around `a`, `b` and `s`, then [and'].
sourceraw docstring

cgclj/s

(cg & res)

As for [grp], but uses a capturing group.

As for [grp], but uses a capturing group.
sourceraw docstring

escclj/s

(esc s)

Escapes s (a String) for use in a regex, returning a String. Note that unlike most other fns in this namespace, this one does not support a regex as an input.

Escapes `s` (a `String`) for use in a regex, returning a `String`.  Note that
unlike most other fns in this namespace, this one does _not_ support a regex
as an input.
sourceraw docstring

exnclj/s

(exn n re)

Returns a regex where re will match exactly n times. Does not perform any grouping.

Returns a regex where `re` will match exactly `n` times. Does not perform any
grouping.
sourceraw docstring

exn-cgclj/s

(exn-cg n & res)

[cg] then [exn].

[cg] then [exn].
sourceraw docstring

exn-grpclj/s

(exn-grp n & res)

[grp] then [exn].

[grp] then [exn].
sourceraw docstring

exn-ncgclj/s

(exn-ncg nm n & res)

[ncg] then [exn].

[ncg] then [exn].
sourceraw docstring

grpclj/s

(grp & res)

As for [join], but encloses the joined res into a single non-capturing group.

As for [join], but encloses the joined `res` into a single non-capturing
group.
sourceraw docstring

joinclj/s

(join & res)

Returns a regex that is the res joined together. Each element in res can be a regex, String or something that can be turned into a String. Returns nil if no res are provided

Returns a regex that is the ` res` joined together. Each element in `res` can
be a regex, `String` or something that can be turned into a `String`.  Returns
`nil` if no `res` are provided
sourceraw docstring

n2mclj/s

(n2m n m re)

Returns a regex where re will match from n to m times. Does not perform any grouping.

Returns a regex where `re` will match from `n` to `m` times. Does not perform
any grouping.
sourceraw docstring

n2m-cgclj/s

(n2m-cg n m & res)

[cg] then [n2m].

[cg] then [n2m].
sourceraw docstring

n2m-grpclj/s

(n2m-grp n m & res)

[grp] then [n2m].

[grp] then [n2m].
sourceraw docstring

n2m-ncgclj/s

(n2m-ncg nm n m & res)

[ncg] then [n2m].

[ncg] then [n2m].
sourceraw docstring

ncgclj/s

(ncg nm & res)

As for [grp], but uses a named capturing group named nm. Returns nil if nm is nil or blank. Throws if nm is an invalid name for a named capturing group (alphanumeric only, must start with an alphabetical character, must be unique within the regex).

As for [grp], but uses a named capturing group named `nm`.  Returns `nil` if
`nm` is `nil` or blank. Throws if `nm` is an invalid name for a named capturing
group (alphanumeric only, must start with an alphabetical character, must be
unique within the regex).
sourceraw docstring

nomclj/s

(nom n re)

Returns a regex where re will match n or more times. Does not perform any grouping.

Returns a regex where `re` will match `n` or more times. Does not perform any
grouping.
sourceraw docstring

nom-cgclj/s

(nom-cg n & res)

[cg] then [nom].

[cg] then [nom].
sourceraw docstring

nom-grpclj/s

(nom-grp n & res)

[grp] then [nom].

[grp] then [nom].
sourceraw docstring

nom-ncgclj/s

(nom-ncg nm n & res)

[ncg] then [nom].

[ncg] then [nom].
sourceraw docstring

oomclj/s

(oom re)

Returns a regex where re will match one or more times. Does not perform any grouping.

Returns a regex where `re` will match one or more times. Does not perform any
grouping.
sourceraw docstring

oom-cgclj/s

(oom-cg & res)

[cg] then [oom].

[cg] then [oom].
sourceraw docstring

oom-grpclj/s

(oom-grp & res)

[grp] then [oom].

[grp] then [oom].
sourceraw docstring

oom-ncgclj/s

(oom-ncg nm & res)

[ncg] then [oom].

[ncg] then [oom].
sourceraw docstring

optclj/s

(opt re)

Returns a regex where re is optional. Does not perform any grouping.

Returns a regex where `re` is optional. Does not perform any grouping.
sourceraw docstring

opt-cgclj/s

(opt-cg & res)

[cg] then [opt].

[cg] then [opt].
sourceraw docstring

opt-grpclj/s

(opt-grp & res)

[grp] then [opt].

[grp] then [opt].
sourceraw docstring

opt-ncgclj/s

(opt-ncg nm & res)

[ncg] then [opt].

[ncg] then [opt].
sourceraw docstring

or'clj/s

(or' a b)
(or' a b s)

Returns an 'inclusive or' regex that will match a or b, or both, in any order, and with the separator regex (if provided) between them. This is implemented as ASB|BSA|A|B, which means that A and B must be distinct (must not match each other). Does not perform any grouping, either on a, b, or s - for that use [or-grp].

Returns an 'inclusive or' regex that will match `a` or `b`, or both, in any
order, and with the `s`eparator regex (if provided) between them.  This is
implemented as `ASB|BSA|A|B`, which means that A and B must be distinct (must
not match each other).  Does not perform any grouping, either on `a`, `b`, or
`s` - for that use [or-grp].
sourceraw docstring

or-grpclj/s

(or-grp a b)
(or-grp a b s)

[grp] around a, b and s, then [or'].

[grp] around `a`, `b` and `s`, then [or'].
sourceraw docstring

qotclj/s

(qot s)

Quotes s (a String) for use in a regex, returning a regex. Note that unlike most other fns in this namespace, this one does not support a regex as an input.

Quotes `s` (a `String`) for use in a regex, returning a regex.  Note that
unlike most other fns in this namespace, this one does _not_ support a regex
as an input.
sourceraw docstring

zomclj/s

(zom re)

Returns a regex where re will match zero or more times. Does not perform any grouping.

Returns a regex where `re` will match zero or more times. Does not perform
any grouping.
sourceraw docstring

zom-cgclj/s

(zom-cg & res)

[cg] then [zom].

[cg] then [zom].
sourceraw docstring

zom-grpclj/s

(zom-grp & res)

[grp] then [zom].

[grp] then [zom].
sourceraw docstring

zom-ncgclj/s

(zom-ncg nm & res)

[ncg] then [zom].

[ncg] then [zom].
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close