Previously this type extended CreativeWork. However, to avoid consuming more memory than necessary when creating directory listings with many files, it now extends Entity.

Properties

The File type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
name	The name of the file.	String	-	schema:name	-
path	The path (absolute or relative) of the file on the file system	String	-	stencila:path	-
mediaType	IANA media type (MIME type).	String	-	schema:encodingFormat	encodingFormat, media-type, media_type
transferEncoding	The encoding used for the context (e.g. base64, gz)	String	-	stencila:transferEncoding	transfer-encoding, transfer_encoding
size	The size of the content in bytes	UnsignedInteger	-	schema:size	-
content	The content of the file.	String	-	schema:content	-

Related

The File type is related to these types:

• Parents: Entity
• Children: none

Formats

The File type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss
JATS
Markdown	⚠️ High loss
Stencila Markdown	⚠️ High loss
Quarto Markdown	⚠️ High loss
MyST Markdown	⚠️ High loss
LLM Markdown	⚠️ High loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory
Stencila Web Bundle
Debug	🔷 Low loss

Bindings

The File type is represented in:

• JSON-LD
• JSON Schema
• Python class File
• Rust struct File
• TypeScript class File

Source

This documentation was generated from File.yaml by docs_types.rs.