Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

Const default

  • default(idl: { IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: (args: Type[], ret: Type[], annotations?: string[]) => FuncClass; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: <T>(t: Type<T>) => OptClass<T>; Principal: PrincipalClass; Rec: () => RecClass; Record: (t: Record<string, Type>) => RecordClass; Reserved: ReservedClass; Text: TextClass; Tuple: <T>(...types: T) => TupleClass<T>; Variant: (fields: Record<string, Type>) => VariantClass; Vec: <T>(t: Type<T>) => VecClass<T>; Service: any } }): ServiceClass
  • Parameters

    • idl: { IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: (args: Type[], ret: Type[], annotations?: string[]) => FuncClass; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: <T>(t: Type<T>) => OptClass<T>; Principal: PrincipalClass; Rec: () => RecClass; Record: (t: Record<string, Type>) => RecordClass; Reserved: ReservedClass; Text: TextClass; Tuple: <T>(...types: T) => TupleClass<T>; Variant: (fields: Record<string, Type>) => VariantClass; Vec: <T>(t: Type<T>) => VecClass<T>; Service: any } }
      • IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: (args: Type[], ret: Type[], annotations?: string[]) => FuncClass; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: <T>(t: Type<T>) => OptClass<T>; Principal: PrincipalClass; Rec: () => RecClass; Record: (t: Record<string, Type>) => RecordClass; Reserved: ReservedClass; Text: TextClass; Tuple: <T>(...types: T) => TupleClass<T>; Variant: (fields: Record<string, Type>) => VariantClass; Vec: <T>(t: Type<T>) => VecClass<T>; Service: any }
        • Bool: BoolClass
        • Empty: EmptyClass
        • Float32: FloatClass
        • Float64: FloatClass
        • Func: (args: Type[], ret: Type[], annotations?: string[]) => FuncClass
            • (args: Type[], ret: Type[], annotations?: string[]): FuncClass
            • Parameters

              • args: Type[]

                array of IDL Types

              • ret: Type[]

                array of IDL Types

              • Optional annotations: string[]

                array of strings, [] by default

              Returns FuncClass

              new FuncClass

        • Int: IntClass
        • Int16: FixedIntClass
        • Int32: FixedIntClass
        • Int64: FixedIntClass
        • Int8: FixedIntClass
        • Nat: NatClass
        • Nat16: FixedNatClass
        • Nat32: FixedNatClass
        • Nat64: FixedNatClass
        • Nat8: FixedNatClass
        • Null: NullClass
        • Opt: <T>(t: Type<T>) => OptClass<T>
            • <T>(t: Type<T>): OptClass<T>
            • Type parameters

              • T

              Parameters

              • t: Type<T>

                IDL Type

              Returns OptClass<T>

              OptClass of Type

        • Principal: PrincipalClass
        • Rec: () => RecClass
            • (): RecClass
            • Returns RecClass

              new RecClass

        • Record: (t: Record<string, Type>) => RecordClass
            • (t: Record<string, Type>): RecordClass
            • Parameters

              • t: Record<string, Type>

                Record of string and IDL Type

              Returns RecordClass

              RecordClass of string and Type

        • Reserved: ReservedClass
        • Text: TextClass
        • Tuple: <T>(...types: T) => TupleClass<T>
            • <T>(...types: T): TupleClass<T>
            • Type parameters

              • T: any[]

              Parameters

              • Rest ...types: T

                array of any types

              Returns TupleClass<T>

              TupleClass from those types

        • Variant: (fields: Record<string, Type>) => VariantClass
            • (fields: Record<string, Type>): VariantClass
            • Parameters

              • fields: Record<string, Type>

                Record of string and IDL Type

              Returns VariantClass

              VariantClass

        • Vec: <T>(t: Type<T>) => VecClass<T>
            • <T>(t: Type<T>): VecClass<T>
            • Type parameters

              • T

              Parameters

              • t: Type<T>

                IDL Type

              Returns VecClass<T>

              VecClass from that type

        • Service: function
          • Service(t: Record<string, FuncClass>): ServiceClass
          • Parameters

            • t: Record<string, FuncClass>

            Returns ServiceClass

    Returns ServiceClass

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Class
  • Class with type parameter
  • Enumeration