Liking cljdoc? Tell your friends :D

clojure.core.contracts

Contracts programming for Clojure.

In progress.

Based on Trammel and clojure-contracts.

Releases and Dependency Information

Latest stable release: 0.0.5

Leiningen dependency information:

[org.clojure/core.contracts "0.0.5"]

Maven dependency information:

<dependency>
  <groupId>org.clojure</groupId>
  <artifactId>core.contracts</artifactId>
  <version>0.0.5</version>
</dependency>

Example Usage

    (use 'clojure.core.contracts)
	
	(def secure-doubler
	  (with-constraints
	  	(fn [n] (* 2 n))
	  	(contract doubler
          "ensures doubling"
          [x] [number? => (= (* 2 x) %)]
          [x y] [(every? number? [x y])
                   =>
                 (= (* 2 (+ x y)) %)])))

    (secure-doubler 10)
    ;=> 20

Refer to docstrings in the clojure.core.contracts namespace.

Documentation

core.contracts API

See also the wiki for some documentation and examples.

Developer Information

Change Log

  • Release 0.0.5 on 2013.06.28
    • Speedier constrained record perf.
  • Release 0.0.4 on 2013.03.07
    • Rolled in defconstrainedrecord
    • Rolled in associative checks
  • Release 0.0.1 on 2012.06.01
    • Rolled in contract, with-constraints and provide from Trammel

Copyright and License

Copyright (c) Rich Hickey, Michael Fogus and contributors, 2012. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.

Can you improve this documentation? These fine people already did:
fogus, Fogus & Jakub Holy
Edit on GitHub

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

× close