-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Obtain minified jQuery code
--   
--   This package bundles the minified jQuery code into a Haskell
--   package, so it can be depended upon by Cabal packages. The first three
--   components of the version number match the upstream jQuery version.
--   The package is designed to meet the redistribution requirements of
--   downstream users (e.g. Debian).
@package js-jquery
@version 3.7.1

-- | Module for accessing minified jQuery code (http://jquery.com/).
--   As an example:
--   
--   
--   import qualified Language.Javascript.JQuery as JQuery
--   
--   main = do
--       putStrLn $ "jQuery version " ++ show JQuery.version ++ " source:"
--       putStrLn =<< readFile =<< JQuery.file
--   
--   
--   This package installs data files containing the jQuery sources, which
--   must be available at runtime. If you want to produce an executable
--   with no dependency on associated data files, you can use the
--   file-embed library
--   (https://hackage.haskell.org/package/file-embed):
--   
--   
--   {-# LANGUAGE TemplateHaskell #-}
--   
--   import Data.FileEmbed
--   import qualified Data.ByteString as BS
--   import qualified Language.Javascript.JQuery as JQuery
--   import Language.Haskell.TH.Syntax
--   
--   main = print jQueryContents
--   
--   jQueryContents :: BS.ByteString
--   jQueryContents = $(embedFile =<< runIO JQuery.file)
--   
module Language.Javascript.JQuery

-- | The version of jQuery provided by this package. Not necessarily the
--   version of this package, but the versions will match in the first
--   three digits.
version :: Version

-- | A local file containing the minified jQuery code for version.
file :: IO FilePath

-- | A remote URL of the jQuery sources for version. The URL does
--   not have a protocol prefix, so users may need to prepend either
--   "http:" or "https:" (both work). The URL currently
--   uses the jQuery CDN links at http://code.jquery.com/.
--   Alternative CDN links are listed at
--   http://jquery.com/download/#using-jquery-with-a-cdn.
url :: String
