Skip to content

Navigation Menu

Sign in
Appearance settings
Sign up
Appearance settings

Latest commit

 

History

History
History
74 lines (56 loc) · 1.99 KB

File metadata and controls

74 lines (56 loc) · 1.99 KB
Copy raw file
Download raw file
Outline
Edit and raw actions

Miguel Module documentation

This is a simple library with some methods to know more about me :D. It is intended to be used in my own portfolio but you can use it however you want.

You can automate payments with the support method ;).

Installing:

  • npm: npm install miguel --save :DD

  • deno: import miguel from 'https://cdn.skypack.dev/miguel';

Usage:

To see all raw data you just can import directly from metadata.js:

import meta from 'miguel/metadata.js'
console.log(meta)

To import methods you can do:

import { profile, contact, at, support, projects } from 'miguel'

This module have five methods, they are for getting specific data inside the meta info object.

  • profile: Get the main profile data.

    • Returns: Onject with profile data.
  • contact: Get contact info

    • Params:
      • way?: String
    • Returns: If the platform (way) is provided it returns the string with the contact info. If not, returns all the contact info.
console.log(contact())
console.log(contact('telegram'))
  • support
    • Params:
      • way?: String
    • Returns: If the platform (way) is provided it returns the string with the suport info. If not, returns all the support info.
console.log(support())
console.log(support('bitcoin'))
  • at
    • Params:
      • platform?: String
    • Returns: If the platform (way) is provided it returns the string with the profile info. If not, returns all the social media profiles info.
console.log(at())
console.log(at('github'))
  • projects
    • Params:
      • name?: String
    • Returns: If the project name (name) is provided it returns an object with the project info. If not, returns all the projects inside an array.
console.log(projects())
console.log(projects('astrodon'))

Deno Support:

This package is also compatible with Deno, just do:

import { profile, contact, at, support, projects } from 'https://cdn.skypack.dev/miguel/index.js'
Morty Proxy This is a proxified and sanitized view of the page, visit original site.