Module
Foreign.ReadWrite
- Package
- purescript-foreign-readwrite
- Repository
- artemisSystem/purescript-foreign-readwrite
#ReadForeign Source
class ReadForeign a where
Members
readForeign :: forall m. Monad m => Foreign -> FT m a
Instances
ReadForeign Foreign
ReadForeign Void
ReadForeign String
ReadForeign Char
ReadForeign Boolean
ReadForeign Number
ReadForeign Int
(ReadForeign a) => ReadForeign (Identity a)
(ReadForeign a) => ReadForeign (Array a)
(ReadForeign a) => ReadForeign (Object a)
(ReadForeign a) => ReadForeign (Maybe a)
(RowToList row rl, ReadForeignRecord rl row) => ReadForeign (Record row)
(RowToList row rl, ReadForeignRecord rl row) => ReadForeign (IncompleteRecord (Record row))
Does not error if extra keys exist in the foreign object being read. Preserves key order.
#WriteForeign Source
class WriteForeign a where
Members
writeForeign :: a -> Foreign
Instances
WriteForeign Foreign
WriteForeign Void
WriteForeign String
WriteForeign Char
WriteForeign Boolean
WriteForeign Number
WriteForeign Int
(WriteForeign a) => WriteForeign (Identity a)
(WriteForeign a) => WriteForeign (Array a)
(WriteForeign a) => WriteForeign (Object a)
(WriteForeign a) => WriteForeign (Maybe a)
(RowToList row rl, WriteForeignRecord rl row) => WriteForeign (Record row)
Preserves key order.
#IncompleteRecord Source
newtype IncompleteRecord r
Constructors
Instances
Newtype (IncompleteRecord r) _
Generic (IncompleteRecord r) _
(Show r) => Show (IncompleteRecord r)
(RowToList row rl, ReadForeignRecord rl row) => ReadForeign (IncompleteRecord (Record row))
Does not error if extra keys exist in the foreign object being read. Preserves key order.
#ReadForeignRecord Source
class ReadForeignRecord :: RowList Type -> Row Type -> Constraint
class ReadForeignRecord rl row | rl -> row where
Members
readForeignRecordImpl :: forall proxy m. Monad m => proxy rl -> Boolean -> Object Foreign -> FT m (Builder (Record ()) (Record row))
Instances
ReadForeignRecord Nil ()
(IsSymbol key, Cons key focus tail row, Lacks key tail, ReadForeignRecord rlTail tail, ReadForeign focus) => ReadForeignRecord (Cons key focus rlTail) row
#readForeignRecord Source
readForeignRecord :: forall proxy rl row m. Monad m => RowToList row rl => ReadForeignRecord rl row => proxy rl -> Boolean -> Foreign -> FT m (Record row)
#WriteForeignRecord Source
class WriteForeignRecord :: RowList Type -> Row Type -> Constraint
class WriteForeignRecord rl row | rl -> row where
Members
writeForeignRecordImpl :: forall proxy. proxy rl -> Record row -> Object Foreign
Instances
WriteForeignRecord Nil ()
(IsSymbol key, Cons key focus tail row, Lacks key tail, WriteForeignRecord rlTail tail, WriteForeign focus) => WriteForeignRecord (Cons key focus rlTail) row
#writeForeignRecord Source
writeForeignRecord :: forall proxy rl row. WriteForeignRecord rl row => proxy rl -> Record row -> Foreign
- Modules
- Foreign.
ReadWrite
If any extra keys exist in the foreign object being read, it will result in an error. Preserves key order.