Liking cljdoc? Tell your friends :D
Clojure only.

flanders.type-script

Render flanders.types types as TypeScript types.

See: https://github.com/microsoft/TypeScript/blob/f30e8a284ac479a96ac660c94084ce5170543cc4/doc/spec.md#A

Render flanders.types types as TypeScript types.

See: https://github.com/microsoft/TypeScript/blob/f30e8a284ac479a96ac660c94084ce5170543cc4/doc/spec.md#A
raw docstring

*flags*clj

A set of keywords used by the type-script-declaration and type-script-declarations functions.

Flags may be one of the following

  • :warn-on-duplicate-entries causes a warning to be printed for each key in a flanders.types.MapType which has more than one disctinct associated value type. Note, this is not the same as a single key haveing a value type of flanders.types.EitherType.

  • :warn-on-duplicate-names when rendering multiple type declarations, causes a warning to be printed for each group of Flanders typess which have the same :name.

A set of keywords used by the `type-script-declaration` and
`type-script-declarations` functions.

Flags may be one of the following

* `:warn-on-duplicate-entries` causes a warning to be printed
   for each key in a `flanders.types.MapType` which has more than
   one disctinct associated value type. Note, this is not the same
   as a single key haveing a value type of
  `flanders.types.EitherType`.

* `:warn-on-duplicate-names` when rendering multiple type
  declarations, causes a warning to be printed for each group of
  Flanders typess which have the same `:name`.
sourceraw docstring

type-alias-declarationclj

(type-alias-declaration x)
source

type-enum-declarationclj

(type-enum-declaration x)
source

type-script-declarationclj

(type-script-declaration x)

Attempt to render x as a TypeScript declaration.

Attempt to render `x` as a TypeScript declaration.
sourceraw docstring

type-script-declarationsclj

(type-script-declarations xs)
(type-script-declarations xs {{:as flags} :flags})
source

type-script-interface-declarationclj

(type-script-interface-declaration x)
source

type-script-mungeclj

(type-script-munge s)
source

type-script-property-namesclj

(type-script-property-names x)
source

type-script-property-signaturesclj

(type-script-property-signatures x)
source

type-script-qualified-type-nameclj

(type-script-qualified-type-name x)
source

type-script-sequence-typeclj

(type-script-sequence-type x)
source

type-script-typeclj

(type-script-type x)

Render x as a TypeScript type e.g. one of

  • UnionOrIntersectionOrPrimaryType,
  • FunctionType, or
  • ConstructorType

as defined in the TypeScript grammar.

Render `x` as a TypeScript type e.g. one of

  * UnionOrIntersectionOrPrimaryType,
  * FunctionType, or
  * ConstructorType

as defined in the TypeScript grammar.
sourceraw docstring

type-script-type-nameclj

(type-script-type-name x)

Attempt to return the TypeScript type name of x. Returns nil if the type name cannot be determined.

Attempt to return the TypeScript type name of `x`. Returns `nil` if
the type name cannot be determined.
sourceraw docstring

type-script-unionclj

(type-script-union xs)

Render xs as a TypeScript UnionType or "any".

Render `xs` as a TypeScript UnionType or "any".
sourceraw docstring

TypeScriptEnumDeclarationcljprotocol

-type-script-enum-declarationclj

(-type-script-enum-declaration this)
source

TypeScriptInterfaceDeclarationcljprotocol

-type-script-interface-declarationclj

(-type-script-interface-declaration this)
source

TypeScriptPropertyNamescljprotocol

-type-script-property-namesclj

(-type-script-property-names this)
source

TypeScriptPropertySignaturescljprotocol

-type-script-property-signaturesclj

(-type-script-property-signatures this)
source

TypeScriptTypecljprotocol

-type-script-typeclj

(-type-script-type this)
source

TypeScriptTypeNamecljprotocol

-type-script-type-nameclj

(-type-script-type-name this)
source

warn-on-duplicate-names?clj

(warn-on-duplicate-names?)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close