FsLiveDocsFsLiveDocsFsLiveDocsFsLiveDocsFsLiveDocsFsLiveDocsFsLiveDocsFsLiveDocs
  • Home
  • API
  • GitHub
  • 0.3.0
    • 0.14.4
    • 0.14.3
    • 0.14.2
    • 0.14.1
    • 0.14.0
    • 0.13.0
    • 0.12.0
    • 0.11.2
    • 0.11.1
    • 0.11.0
    • 0.10.0
    • 0.9.1
    • 0.9.0
    • 0.8.1
    • 0.8.0
    • 0.7.3
    • 0.7.2
    • 0.7.1
    • 0.7.0
    • 0.6.2
    • 0.6.1
    • 0.6.0
    • 0.5.0
    • 0.4.1
    • 0.4.0
    • 0.3.8
    • 0.3.7
    • 0.3.6
    • 0.3.5
    • 0.3.4
    • 0.3.3
    • 0.3.2
    • 0.3.1
    • 0.3.0
  • light
  • dark
  • cupcake
  • dracula
  • emerald
  • corporate
  • retro
  • cyberpunk

DocsNamespace

Contents

CustomerContextModuleOrderModuleOrderRecord

On This Page

    Overview

    • Home
    • API Reference

    Docs

    • Get started
    • Guides
      • Verify F# examples
      • Add semantic code tooltips
      • Transclude source and examples
      • Link to API symbols
      • Configure pages with front matter
      • Configure navigation and branding
      • Capture and publish releases
    • Advanced authoring
    • Command reference
    • FsLiveDocs reference
    • Dogfood FsLiveDocs

    API Reference

    • Acme.Docs
      • CustomerContext
        • Operations
          • loadPreferredCustomer
          • price
      • Order
        • Operations
          • create
          • total
      • Order
        • Representation
          • Id
          • Subtotal
    • FsLiveDocs
      • Cli
        • Program
          • Operations
            • printBanner
            • getUnifiedPackage
            • auditAction
            • captureAction
            • historyAddAction
            • buildAction
            • buildHistoryAction
            • main
        • Arguments
          • Union cases
            • IsPort
            • IsWarn_As_Error
            • IsVerbosity
            • IsBuild_History
            • IsInit
            • IsDiscover_Projects
            • IsSha256
            • IsTest
            • IsCapsule
            • IsAudit
            • IsUrl
            • IsGenerate_CI
            • IsHost
            • IsVersion
            • IsExtract
            • IsTheme
            • IsWatch
            • IsInspect
            • IsOutput
            • IsGenerate_Tests
            • IsBanner
            • IsDry_Run
            • IsHistory_Add
            • IsIgnore
            • IsCapture
            • IsInteractive
            • IsBuild
            • Init
            • Generate_CI
            • Generate_Tests
            • Extract
            • Capture
            • Inspect
            • History_Add
            • Test
            • Audit
            • Build
            • Build_History
            • Watch
            • Theme
            • Version
            • Output
            • Capsule
            • Url
            • Sha256
            • Host
            • Port
            • Ignore
            • Warn_As_Error
            • Verbosity
            • Interactive
            • Banner
            • Discover_Projects
            • Dry_Run
    • FsLiveDocs.Core
      • ContentProvider
        • Operations
          • exampleShortcodePattern
          • transcludedExampleNames
          • outputPathFor
          • copyStaticFiles
          • defaultTitle
          • pipeline
          • deserializer
          • findIndexIteration
          • parseFrontMatter
          • findMember
          • findEntity
          • findExample
          • expandTransclusions
          • resolveSnippets
          • loadPage
          • scanDocsWithOptions
          • scanDocs
          • applyApiDocsWithOptions
          • applyApiDocs
      • DocScenarioSamples
        • Operations
          • currentUser
          • loadUser
          • greet
      • Documentation
        • Operations
          • text
          • markdown
          • plainText
          • isEmpty
      • DocumentationDiscovery
        • Operations
          • normalizeSource
          • scanFsharpFences
          • sourceHash
          • contextHash
          • parseMode
          • discoverMarkdown
          • validateCoverage
          • compilationUnits
          • verificationCases
          • generatedCases
        • FenceMatch
          • Representation
            • Info
            • Code
            • Start
            • Length
      • ExampleTranscript
        • Operations
          • parse
        • Parsed
          • Representation
            • DisplayText
            • Script
            • Interactions
            • ExpectedOutput
      • History
        • Operations
          • ApiModelSchemaVersion
          • SemanticSchemaVersion
          • ManifestSchemaVersion
          • sha256
          • loadArtifact
          • loadSemanticArtifact
          • loadManifest
      • ReleaseCapsule
        • Operations
          • ManifestSchemaVersion
          • ContentSchemaVersion
          • HistoryIndexSchemaVersion
          • create
          • load
          • inspect
          • materializeContent
          • loadHistoryIndex
          • acquire
      • SemanticCode
        • Operations
          • htmlStartMarker
          • htmlEndMarker
          • defaults
          • disabled
          • formatFences
        • Options
          • Representation
            • Enabled
            • Artifact
            • Prelude
      • Serialization
        • Operations
          • jsonSettings
      • SourceParameters
        • Operations
          • parameterTexts
      • SymbolLister
        • Operations
          • extractExamples
          • authoredParameterNames
          • unnamedParameterPositions
          • displayParameterNames
          • reconcileUsageSignature
          • mapMemberSignature
          • mapMember
          • mapEntity
          • signatureNameMismatches
          • parameterDiagnostics
          • reconstructHierarchy
          • extractFromProjectWithDiagnostics
          • extractFromProject
          • merge
      • TranscriptSamples
        • Operations
          • mapTranscriptExample
      • ApiDiagnostic
        • Representation
          • Code
          • Symbol
          • Location
          • Message
          • Remedy
      • ApiModelArtifact
        • Representation
          • SchemaVersion
          • Package
      • CompilationUnit
        • Representation
          • Id
          • ProjectPath
          • Prelude
          • Blocks
      • ContentMetadata
        • Representation
          • Title
          • Type
          • Project
          • TargetFramework
          • Platform
      • ContentPage
        • Representation
          • Metadata
          • ContentHtml
          • FilePath
          • OutputPath
          • SectionOrder
      • DocumentationBlock
        • Representation
          • Id
          • Origin
          • SourcePath
          • Ordinal
          • ExpandedSource
          • SourceHash
          • Mode
          • Project
      • DocumentationBlockMode
        • Union cases
          • IsRun
          • IsPage
          • IsTranscript
          • IsPrepare
          • IsNoCheck
          • IsIsolated
          • Page
          • Prepare
          • Isolated
          • Run
          • Transcript
          • NoCheck
      • DocumentationBlockOrigin
        • Union cases
          • IsSourceSnippet
          • IsMarkdownFence
          • IsXmlExample
          • IsApiEnrichment
          • MarkdownFence
          • SourceSnippet
          • XmlExample
          • ApiEnrichment
      • DocumentationNode
        • Representation
          • Kind
          • Text
          • Target
          • Language
          • Children
      • DocumentationNodeKind
        • Union cases
          • IsLineBreak
          • IsParagraph
          • IsText
          • IsExternalLink
          • IsCodeBlock
          • IsInlineCode
          • IsUnorderedList
          • IsListItem
          • IsMarkdown
          • IsOrderedList
          • IsSymbolReference
          • Text
          • Paragraph
          • InlineCode
          • CodeBlock
          • SymbolReference
          • ExternalLink
          • UnorderedList
          • OrderedList
          • ListItem
          • LineBreak
          • Markdown
      • EntityKind
        • Union cases
          • IsNamespace
          • IsRecord
          • IsType
          • IsModule
          • IsUnion
          • Namespace
          • Module
          • Record
          • Union
          • Type
      • EntityModel
        • Representation
          • Id
          • Name
          • Kind
          • Summary
          • Members
          • Examples
          • Entities
      • ExampleModel
        • Representation
          • Create
          • Name
          • Content
          • ExpectedOutput
          • Scenario
          • IsSnapshotTest
          • NoCheckReason
      • ExampleSnapshotModel
        • Representation
          • Name
          • Scenario
          • Source
          • ExpectedOutput
          • ActualOutput
          • Status
      • ExampleStatus
        • Union cases
          • IsFirstCut
          • IsError
          • IsVerified
          • IsMismatch
          • FirstCut
          • Verified
          • Mismatch
          • Error
      • FSharpListConverter
        • Operations
          • ``.ctor``
      • FSharpOptionConverter
        • Operations
          • ``.ctor``
      • FSharpUnionConverter
        • Operations
          • ``.ctor``
      • GeneratedVerificationAction
        • Union cases
          • IsExecuteBlock
          • IsExecuteTranscriptBlock
          • IsCompileUnit
          • CompileUnit
          • ExecuteBlock
          • ExecuteTranscriptBlock
      • GeneratedVerificationCase
        • Representation
          • Id
          • ProjectPath
          • SourcePath
          • ExpandedMarkdown
          • Action
      • HistoryEntry
        • Representation
          • Version
          • ModelPath
          • ModelSha256
          • SemanticPath
          • SemanticSha256
          • DocsPath
      • HistoryManifest
        • Representation
          • SchemaVersion
          • CurrentVersion
          • Entries
      • MemberModel
        • Representation
          • Id
          • Name
          • Signature
          • Parameters
          • ReturnType
          • Summary
          • Remarks
          • Examples
          • Location
      • NavigationItem
        • Representation
          • Label
          • Href
      • PackageInfo
        • Representation
          • Name
          • EntityIds
      • PackageModel
        • Representation
          • Version
          • Entities
          • Scenarios
          • Packages
      • ParameterModel
        • Representation
          • Name
          • Type
          • Description
      • ProjectSnapshotModel
        • Representation
          • ProjectPath
          • ProjectNamespace
          • Examples
      • ReleaseAsset
        • Representation
          • Path
          • MediaType
          • Sha256
          • Size
      • ReleaseCapsuleManifest
        • Representation
          • SchemaVersion
          • ProductVersion
          • SourceRevision
          • CaptureToolVersion
          • Api
          • Semantic
          • Content
      • ReleaseCapsuleReport
        • Representation
          • Path
          • Sha256
          • CompressedSize
          • UncompressedSize
          • Manifest
          • Counts
      • ReleaseCaptureCounts
        • Representation
          • Entities
          • Members
          • Examples
          • DocumentationNodes
          • Pages
          • CodeBlocks
          • Tooltips
          • Diagnostics
          • Assets
      • ReleaseComponent
        • Representation
          • SchemaVersion
          • Path
          • Sha256
          • Size
      • ReleaseContentArtifact
        • Representation
          • SchemaVersion
          • Pages
          • Assets
          • Site
      • ReleaseContentPage
        • Representation
          • SourcePath
          • Metadata
          • Markdown
      • ReleaseHistoryEntry
        • Representation
          • Version
          • CapsulePath
          • CapsuleUrl
          • CapsuleSha256
      • ReleaseHistoryIndex
        • Representation
          • SchemaVersion
          • CurrentVersion
          • Entries
      • ResolvedProject
        • Representation
          • ProjectPath
          • AssemblyPath
          • ProjectNamespace
      • ScenarioModel
        • Representation
          • Name
          • MethodId
      • SemanticCodeBlock
        • Representation
          • Id
          • SourceHash
          • ContextHash
          • Lines
          • Tooltips
          • Diagnostics
      • SemanticDiagnostic
        • Representation
          • Severity
          • Message
          • StartLine
          • StartColumn
          • EndLine
          • EndColumn
      • SemanticDiagnosticSeverity
        • Union cases
          • IsError
          • IsWarning
          • Warning
          • Error
      • SemanticDocumentationArtifact
        • Representation
          • SchemaVersion
          • Prelude
          • Pages
      • SemanticLine
        • Representation
          • Tokens
      • SemanticPage
        • Representation
          • SourcePath
          • Blocks
      • SemanticToken
        • Representation
          • Text
          • Kind
          • Tooltip
      • SemanticTokenKind
        • Union cases
          • IsKeyword
          • IsNamespace
          • IsUnionCase
          • IsNumber
          • IsPreprocessor
          • IsFunction
          • IsOperator
          • IsPunctuation
          • IsIdentifier
          • IsProperty
          • IsString
          • IsTypeName
          • IsModule
          • IsActivePatternCase
          • IsPlainText
          • IsComment
          • PlainText
          • Keyword
          • Identifier
          • TypeName
          • Function
          • Property
          • UnionCase
          • ActivePatternCase
          • Module
          • Namespace
          • Operator
          • Number
          • String
          • Comment
          • Punctuation
          • Preprocessor
      • SemanticTooltip
        • Representation
          • Signature
          • Documentation
          • Sections
          • Footer
      • SemanticTooltipSection
        • Representation
          • Heading
          • Content
      • SiteConfig
        • Representation
          • RepoUrl
          • SiteName
          • LogoText
          • LogoPath
          • LogoDarkPath
          • ShowSiteName
          • Stylesheet
          • Themes
          • Navigation
          • FSharpPrelude
      • SourceLink
        • Representation
          • File
          • Line
      • VerificationCase
        • Union cases
          • IsCompile
          • IsExecute
          • IsExecuteTranscript
          • Compile
          • Execute
          • ExecuteTranscript
    • FsLiveDocs.Renderer
      • Presentation
        • Operations
          • flattenEntities
          • renderDocumentationHtml
          • highlightSignatureHtml
          • synopsis
          • entityExamples
      • SiteBuilder
        • Operations
          • renderPage
          • renderEntityPage
          • generateLlmsTxt
          • build
          • buildAll
          • buildHistory
        • SiteBuildContext
          • Representation
            • Pages
            • Package
            • Config
            • Versions
            • Theme
            • RootPath
            • OutputDir
        • SiteRenderContext
          • Representation
            • AllPages
            • Package
            • Config
            • Versions
            • Theme
            • RootPath
      • Url
        • Operations
          • ensureTrailing
          • resolve
      • View
        • Operations
          • sourceLinkHref
          • h1WithAnchor
          • h2WithAnchor
          • h3WithAnchor
          • navItem
          • sidebarPageLink
          • sidebarEntityLink
          • entitiesForPackage
          • sidebar
          • apiCard
          • layout
    • FsLiveDocs.Runner
      • DocTestRunner
        • Operations
          • snapshotExampleNames
          • collectSnapshotByName
          • collectSnapshots
      • DocumentationCompiler
        • Operations
          • evaluateProjectFor
          • evaluateProject
          • checkUnit
          • checkBlocks
          • checkBlocksWithProject
      • FsiTranscriptRunner
        • Operations
          • runExample
        • DocTestExecutionContext
          • Representation
            • Project
            • References
            • Scenario
            • Example
      • GeneratedVerification
        • Operations
          • runCase
          • compileUncoveredExamples
      • ProjectResolver
        • Operations
          • resolveProjectPath
          • resolveAssemblyPath
          • resolve
      • SemanticExtractor
        • Operations
          • extractBlock
          • extract
          • artifact
      • CheckedCompilationUnit
        • Representation
          • Unit
          • SyntheticSource
          • Diagnostics
          • BlockRanges
          • CheckResults
      • CompilationSourceRange
        • Representation
          • Block
          • StartLine
          • EndLine
      • EvaluatedProject
        • Representation
          • ProjectPath
          • TargetFramework
          • References
          • Defines
          • LanguageVersion
          • OtherOptions
      • MappedCompilerDiagnostic
        • Representation
          • BlockId
          • SourcePath
          • Severity
          • Message
          • StartLine
          • StartColumn
          • EndLine
          • EndColumn