IDBTransaction.hs

{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE ImplicitParams, ConstraintKinds, KindSignatures #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
-- | Generated by dom-gen from IndexedDB-3 (webref). Do not edit.
module JSDOM.Generated.IDBTransaction
       (abort, commit, objectStore, objectStore_, getObjectStoreNames, getMode, getDurability, getDb, getError, getErrorUnsafe, getErrorUnchecked, abortEvent, complete, error, IDBTransaction(..), gTypeIDBTransaction)
       where
import Prelude ((.), (==), (>>=), (<$>), (++), Bool(..), Maybe(..), IO, Int, Word, Double, Float)
import qualified Prelude as P
import Control.Monad (void)
import Control.Lens.Operators ((^.))
import Language.Javascript.JSaddle (JSM, JSVal, JSString, toJSVal, valToBool, valToNumber, js, jss, jsf, jsg, new, function, asyncFunction, jsUndefined, jsNull)
import JSDOM.Types
import qualified JSDOM.Types as Types
import JSDOM.EventTargetClosures (EventName, unsafeEventName, unsafeEventNameAsync)
import JSDOM.Generated.Enums

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/abort MDN IDBTransaction.abort documentation>
abort :: (MonadDOM m) => IDBTransaction -> m ()
abort self = liftDOM (void (self ^. jsf "abort" ()))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/commit MDN IDBTransaction.commit documentation>
commit :: (MonadDOM m) => IDBTransaction -> m ()
commit self = liftDOM (void (self ^. jsf "commit" ()))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStore MDN IDBTransaction.objectStore documentation>
objectStore :: (MonadDOM m, ToJSString name) => IDBTransaction -> name -> m IDBObjectStore
objectStore self name = liftDOM (((self ^. jsf "objectStore" [toJSVal name]) >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStore MDN IDBTransaction.objectStore documentation>
objectStore_ :: (MonadDOM m, ToJSString name) => IDBTransaction -> name -> m ()
objectStore_ self name = liftDOM (void (self ^. jsf "objectStore" [toJSVal name]))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStoreNames MDN IDBTransaction.objectStoreNames documentation>
getObjectStoreNames :: (MonadDOM m) => IDBTransaction -> m DOMStringList
getObjectStoreNames self = liftDOM (((self ^. js "objectStoreNames") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/mode MDN IDBTransaction.mode documentation>
getMode :: (MonadDOM m) => IDBTransaction -> m IDBTransactionMode
getMode self = liftDOM (((self ^. js "mode") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/durability MDN IDBTransaction.durability documentation>
getDurability :: (MonadDOM m) => IDBTransaction -> m IDBTransactionDurability
getDurability self = liftDOM (((self ^. js "durability") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/db MDN IDBTransaction.db documentation>
getDb :: (MonadDOM m) => IDBTransaction -> m IDBDatabase
getDb self = liftDOM (((self ^. js "db") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/error MDN IDBTransaction.error documentation>
getError :: (MonadDOM m) => IDBTransaction -> m (Maybe DOMException)
getError self = liftDOM (((self ^. js "error") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/error MDN IDBTransaction.error documentation>
getErrorUnsafe :: (MonadDOM m, HasCallStack) => IDBTransaction -> m DOMException
getErrorUnsafe self = liftDOM ((((self ^. js "error") >>= fromJSValUnchecked) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/IDBTransaction/error MDN IDBTransaction.error documentation>
getErrorUnchecked :: (MonadDOM m) => IDBTransaction -> m DOMException
getErrorUnchecked self = liftDOM (((self ^. js "error") >>= fromJSValUnchecked))

-- | <https://w3c.github.io/IndexedDB/#dom-idbtransaction-onabort abort event>
abortEvent :: EventName IDBTransaction Event
abortEvent = unsafeEventName (toJSString "abort")

-- | <https://w3c.github.io/IndexedDB/#dom-idbtransaction-oncomplete complete event>
complete :: EventName IDBTransaction Event
complete = unsafeEventName (toJSString "complete")

-- | <https://w3c.github.io/IndexedDB/#dom-idbtransaction-onerror error event>
error :: EventName IDBTransaction Event
error = unsafeEventName (toJSString "error")