Skip to content

FSharpApiEntity

type FSharpApiEntity =
    {
        Name: string
        FullName: string
        Namespace: string
        Kind: FSharpApiEntityKind
        Signature: string
        TypeParameters: string list
        Members: FSharpApiMember list
        Interfaces: string list
        BaseType: string option
        Attributes: string list
        Nested: FSharpApiEntity list
        Doc: FSharpApiDoc
        Slug: string
        Assembly: string
    }
AssemblyNacara.Plugin.FSharpApi

A type, a module, or anything else a page is written about.

Fields

Name: string
FullName: string

Namespace and name, as the compiler knows it.

Namespace: string
Kind: FSharpApiEntityKind
Signature: string

The declaration line: type Route = { … }, module Url.

TypeParameters: string list
Members: FSharpApiMember list
Interfaces: string list

Interfaces this type implements, as a reader would write them.

BaseType: string option

What it inherits from, when that is worth saying.

Attributes: string list

Attributes it carries, without the Attribute suffix.

Nested: FSharpApiEntity list

Modules and types declared inside this one.

Doc: FSharpApiDoc
Slug: string

Path of the page written for it, relative to the api root.

Assembly: string

The assembly it shipped in, which is the package a reader has to reference.