flanders.type-script

Liking cljdoc? Tell your friends :D

Clojure only.

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`.

source raw docstring

type-alias-declaration^clj

(type-alias-declaration x)

source

type-enum-declaration^clj

(type-enum-declaration x)

source

type-script-declaration^clj

(type-script-declaration x)

Attempt to render x as a TypeScript declaration.

Attempt to render `x` as a TypeScript declaration.

source raw docstring

type-script-declarations^clj

(type-script-declarations xs)

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

source

type-script-interface-declaration^clj

(type-script-interface-declaration x)

source

type-script-munge^clj

(type-script-munge s)

source

type-script-property-names^clj

(type-script-property-names x)

source

type-script-property-signatures^clj

(type-script-property-signatures x)

source

type-script-sequence-type^clj

(type-script-sequence-type x)

source

type-script-type^clj

(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.

source raw docstring

type-script-type-name^clj

(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.

source raw docstring

type-script-union^clj

(type-script-union xs)

Render xs as a TypeScript UnionType or "any".

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

source raw docstring

TypeScriptEnumDeclaration^cljprotocol

-type-script-enum-declaration^clj

(-type-script-enum-declaration this)

source

TypeScriptInterfaceDeclaration^cljprotocol

-type-script-interface-declaration^clj

(-type-script-interface-declaration this)

source

TypeScriptPropertyNames^cljprotocol

-type-script-property-names^clj

(-type-script-property-names this)

source

TypeScriptPropertySignatures^cljprotocol

-type-script-property-signatures^clj

(-type-script-property-signatures this)

source

TypeScriptType^cljprotocol

-type-script-type^clj

(-type-script-type this)

source

TypeScriptTypeName^cljprotocol

-type-script-type-name^clj

(-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 shortcuts Report a problem cljdoc on GitHub

× close