NavigationHistoryEntry.hs

{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE ImplicitParams, ConstraintKinds, KindSignatures #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
-- | Generated by dom-gen from html (webref). Do not edit.
module JSDOM.Generated.NavigationHistoryEntry
       (getState, getState_, getUrl, getUrlUnsafe, getUrlUnchecked, getKey, getId, getIndex, getSameDocument, dispose, NavigationHistoryEntry(..), gTypeNavigationHistoryEntry)
       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/NavigationHistoryEntry/getState MDN NavigationHistoryEntry.getState documentation>
getState :: (MonadDOM m) => NavigationHistoryEntry -> m JSVal
getState self = liftDOM (self ^. jsf "getState" ())

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

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrl :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m (Maybe result)
getUrl self = liftDOM (((self ^. js "url") >>= fromMaybeJSString))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrlUnsafe :: (MonadDOM m, HasCallStack, FromJSString result) => NavigationHistoryEntry -> m result
getUrlUnsafe self = liftDOM ((((self ^. js "url") >>= fromMaybeJSString) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrlUnchecked :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getUrlUnchecked self = liftDOM (((self ^. js "url") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/key MDN NavigationHistoryEntry.key documentation>
getKey :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getKey self = liftDOM (((self ^. js "key") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/id MDN NavigationHistoryEntry.id documentation>
getId :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getId self = liftDOM (((self ^. js "id") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/index MDN NavigationHistoryEntry.index documentation>
getIndex :: (MonadDOM m) => NavigationHistoryEntry -> m Int53
getIndex self = liftDOM (((self ^. js "index") >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/sameDocument MDN NavigationHistoryEntry.sameDocument documentation>
getSameDocument :: (MonadDOM m) => NavigationHistoryEntry -> m Bool
getSameDocument self = liftDOM (((self ^. js "sameDocument") >>= valToBool))

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigationhistoryentry-ondispose dispose event>
dispose :: EventName NavigationHistoryEntry Event
dispose = unsafeEventName (toJSString "dispose")